Skip to content

Commit df01249

Browse files
chore(internal): codegen related update (#277)
1 parent 1eb24ad commit df01249

File tree

7 files changed

+17
-40
lines changed

7 files changed

+17
-40
lines changed

buildSrc/src/main/kotlin/onebusaway-sdk.kotlin.gradle.kts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@ configure<SpotlessExtension> {
2222

2323
tasks.withType<KotlinCompile>().configureEach {
2424
compilerOptions {
25+
allWarningsAsErrors = true
2526
freeCompilerArgs = listOf(
26-
"-Xjvm-default=all",
27-
"-Xjdk-release=1.8",
28-
// Suppress deprecation warnings because we may still reference and test deprecated members.
29-
"-Xsuppress-warning=DEPRECATION"
27+
"-Xjvm-default=all",
28+
"-Xjdk-release=1.8",
29+
// Suppress deprecation warnings because we may still reference and test deprecated members.
30+
"-Xsuppress-warning=DEPRECATION"
3031
)
3132
jvmTarget.set(JvmTarget.JVM_1_8)
3233
}

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/services/async/AgenciesWithCoverageServiceAsync.kt

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,7 @@ interface AgenciesWithCoverageServiceAsync {
2424
requestOptions: RequestOptions = RequestOptions.none(),
2525
): AgenciesWithCoverageListResponse
2626

27-
/**
28-
* Returns a list of all transit agencies currently supported by OneBusAway along with the
29-
* center of their coverage area.
30-
*/
27+
/** @see [list] */
3128
suspend fun list(requestOptions: RequestOptions): AgenciesWithCoverageListResponse =
3229
list(AgenciesWithCoverageListParams.none(), requestOptions)
3330

@@ -47,10 +44,7 @@ interface AgenciesWithCoverageServiceAsync {
4744
requestOptions: RequestOptions = RequestOptions.none(),
4845
): HttpResponseFor<AgenciesWithCoverageListResponse>
4946

50-
/**
51-
* Returns a raw HTTP response for `get /api/where/agencies-with-coverage.json`, but is
52-
* otherwise the same as [AgenciesWithCoverageServiceAsync.list].
53-
*/
47+
/** @see [list] */
5448
@MustBeClosed
5549
suspend fun list(
5650
requestOptions: RequestOptions

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/services/async/ConfigServiceAsync.kt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ interface ConfigServiceAsync {
2121
requestOptions: RequestOptions = RequestOptions.none(),
2222
): ConfigRetrieveResponse
2323

24-
/** config */
24+
/** @see [retrieve] */
2525
suspend fun retrieve(requestOptions: RequestOptions): ConfigRetrieveResponse =
2626
retrieve(ConfigRetrieveParams.none(), requestOptions)
2727

@@ -40,10 +40,7 @@ interface ConfigServiceAsync {
4040
requestOptions: RequestOptions = RequestOptions.none(),
4141
): HttpResponseFor<ConfigRetrieveResponse>
4242

43-
/**
44-
* Returns a raw HTTP response for `get /api/where/config.json`, but is otherwise the same
45-
* as [ConfigServiceAsync.retrieve].
46-
*/
43+
/** @see [retrieve] */
4744
@MustBeClosed
4845
suspend fun retrieve(
4946
requestOptions: RequestOptions

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/services/async/CurrentTimeServiceAsync.kt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ interface CurrentTimeServiceAsync {
2121
requestOptions: RequestOptions = RequestOptions.none(),
2222
): CurrentTimeRetrieveResponse
2323

24-
/** current-time */
24+
/** @see [retrieve] */
2525
suspend fun retrieve(requestOptions: RequestOptions): CurrentTimeRetrieveResponse =
2626
retrieve(CurrentTimeRetrieveParams.none(), requestOptions)
2727

@@ -41,10 +41,7 @@ interface CurrentTimeServiceAsync {
4141
requestOptions: RequestOptions = RequestOptions.none(),
4242
): HttpResponseFor<CurrentTimeRetrieveResponse>
4343

44-
/**
45-
* Returns a raw HTTP response for `get /api/where/current-time.json`, but is otherwise the
46-
* same as [CurrentTimeServiceAsync.retrieve].
47-
*/
44+
/** @see [retrieve] */
4845
@MustBeClosed
4946
suspend fun retrieve(
5047
requestOptions: RequestOptions

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/services/blocking/AgenciesWithCoverageService.kt

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,7 @@ interface AgenciesWithCoverageService {
2424
requestOptions: RequestOptions = RequestOptions.none(),
2525
): AgenciesWithCoverageListResponse
2626

27-
/**
28-
* Returns a list of all transit agencies currently supported by OneBusAway along with the
29-
* center of their coverage area.
30-
*/
27+
/** @see [list] */
3128
fun list(requestOptions: RequestOptions): AgenciesWithCoverageListResponse =
3229
list(AgenciesWithCoverageListParams.none(), requestOptions)
3330

@@ -47,10 +44,7 @@ interface AgenciesWithCoverageService {
4744
requestOptions: RequestOptions = RequestOptions.none(),
4845
): HttpResponseFor<AgenciesWithCoverageListResponse>
4946

50-
/**
51-
* Returns a raw HTTP response for `get /api/where/agencies-with-coverage.json`, but is
52-
* otherwise the same as [AgenciesWithCoverageService.list].
53-
*/
47+
/** @see [list] */
5448
@MustBeClosed
5549
fun list(
5650
requestOptions: RequestOptions

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/services/blocking/ConfigService.kt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ interface ConfigService {
2121
requestOptions: RequestOptions = RequestOptions.none(),
2222
): ConfigRetrieveResponse
2323

24-
/** config */
24+
/** @see [retrieve] */
2525
fun retrieve(requestOptions: RequestOptions): ConfigRetrieveResponse =
2626
retrieve(ConfigRetrieveParams.none(), requestOptions)
2727

@@ -38,10 +38,7 @@ interface ConfigService {
3838
requestOptions: RequestOptions = RequestOptions.none(),
3939
): HttpResponseFor<ConfigRetrieveResponse>
4040

41-
/**
42-
* Returns a raw HTTP response for `get /api/where/config.json`, but is otherwise the same
43-
* as [ConfigService.retrieve].
44-
*/
41+
/** @see [retrieve] */
4542
@MustBeClosed
4643
fun retrieve(requestOptions: RequestOptions): HttpResponseFor<ConfigRetrieveResponse> =
4744
retrieve(ConfigRetrieveParams.none(), requestOptions)

onebusaway-sdk-kotlin-core/src/main/kotlin/org/onebusaway/services/blocking/CurrentTimeService.kt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ interface CurrentTimeService {
2121
requestOptions: RequestOptions = RequestOptions.none(),
2222
): CurrentTimeRetrieveResponse
2323

24-
/** current-time */
24+
/** @see [retrieve] */
2525
fun retrieve(requestOptions: RequestOptions): CurrentTimeRetrieveResponse =
2626
retrieve(CurrentTimeRetrieveParams.none(), requestOptions)
2727

@@ -40,10 +40,7 @@ interface CurrentTimeService {
4040
requestOptions: RequestOptions = RequestOptions.none(),
4141
): HttpResponseFor<CurrentTimeRetrieveResponse>
4242

43-
/**
44-
* Returns a raw HTTP response for `get /api/where/current-time.json`, but is otherwise the
45-
* same as [CurrentTimeService.retrieve].
46-
*/
43+
/** @see [retrieve] */
4744
@MustBeClosed
4845
fun retrieve(requestOptions: RequestOptions): HttpResponseFor<CurrentTimeRetrieveResponse> =
4946
retrieve(CurrentTimeRetrieveParams.none(), requestOptions)

0 commit comments

Comments
 (0)