Skip to content

Commit b5862d4

Browse files
committed
docs(plugin/generator): document version info for extension DSL
1 parent 6b7e2aa commit b5862d4

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

plugins/generator/src/main/kotlin/io/github/edricchan03/koogle_api/plugin/generator/KoogleApiGeneratorPluginExtension.kt

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,34 @@ public abstract class KoogleApiGeneratorPluginExtension {
2020

2121
/**
2222
* The file to output to.
23+
*
2324
* If this value is set to `null`, it will be output to the project's build directory
2425
* with the file name "koogle-api-discovery.json".
26+
* @since 0.1.0
2527
*/
2628
public abstract val rootDiscoveryDocOutputFile: RegularFileProperty
2729

2830
/**
2931
* The directory to save all discovery documents to.
30-
* If this value is set to `null`, it will by default be saved to the project's build directory
31-
* in a sub-directory "koogle-api-disc-docs".
32+
*
33+
* If this value is set to `null`, it will by default be saved to the
34+
* project's build directory in a sub-directory "koogle-api-disc-docs".
35+
* @since 0.1.0
3236
*/
3337
public abstract val discoveryDocsOutputDir: DirectoryProperty
3438

35-
/** Mapping function used to generate the output file name based from the specified [DirectoryItem]. */
39+
/**
40+
* Mapping function used to generate the output file name based from
41+
* the specified [DirectoryItem].
42+
* @since 0.1.0
43+
*/
3644
public abstract val outputFileNameMapper: Property<SchemaFileNameMapper>
3745

38-
/** Mapping function used to generate the output file name based from the specified [DirectoryItem]. */
46+
/**
47+
* Mapping function used to generate the output file name
48+
* based from the specified [DirectoryItem].
49+
* @since 0.1.0
50+
*/
3951
public fun outputFileNameMapper(mapper: SchemaFileNameMapper) {
4052
outputFileNameMapper.set(mapper)
4153
}

0 commit comments

Comments
 (0)