Lines Matching +full:java +full:- +full:docs +full:- +full:samples
4 **_Note_: This is Google's fork of Dokka, customized for [Android API reference docs](https://devel…
7 Dokka is a documentation engine for Kotlin, performing the same function as javadoc for Java.
8 Just like Kotlin itself, Dokka fully supports mixed-language Java/Kotlin projects. It understands
9 standard Javadoc comments in Java files and [KDoc comments](https://kotlinlang.org/docs/reference/k…
23 classpath "org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}"
57 // http://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation
61 samples = ['samples/basic.kt', 'samples/advanced.kt']
66 // to enable package-list caching
109 url = "https://github.com/cy6erGn0m/vertx3-lang-kotlin/blob/master/src/main/kotlin"
115 // No default documentation link to kotlin-stdlib
122 url = new URL("https://example.com/docs/")
124 // If package-list file located in non-standard location
125 // packageListUrl = new URL("file:///home/user/localdocs/package-list")
128 // Allows to customize documentation generation options on a per-package basis
131 prefix = "kotlin" // will match kotlin and all sub-packages of it
139 prefix = "kotlin.internal" // will match kotlin.internal and all sub-packages of it
160 …le example project](https://github.com/JetBrains/kotlin-examples/tree/master/gradle/dokka-gradle-e…
165 `com.android.library` and `kotlin-android`.
174 classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:${dokka_version}"
179 apply plugin: 'kotlin-android'
180 apply plugin: 'org.jetbrains.dokka-android'
202 <artifactId>dokka-maven-plugin</artifactId>
206 <phase>pre-site</phase>
219 …* `dokka:dokka` - generate HTML documentation in Dokka format (showing declarations in Kotlin synt…
220 …* `dokka:javadoc` - generate HTML documentation in JavaDoc format (showing declarations in Java sy…
221 * `dokka:javadocJar` - generate a .jar file with JavaDoc format documentation.
228 <artifactId>dokka-maven-plugin</artifactId>
232 <phase>pre-site</phase>
240 <!-- Set to true to skip dokka task, default: false -->
243 <!-- Default: ${project.artifactId} -->
245 <!-- See list of possible formats below -->
247 <!-- Default: ${project.basedir}/target/dokka -->
250 … <!-- Use default or set to custom path to cache directory to enable package-list caching. -->
251 <!-- When set to default, caches stored in $USER_HOME/.cache/dokka -->
254 <!-- List of '.md' files with package and module docs -->
255 … <!-- http://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation -->
261 <!-- List of sample roots -->
263 <dir>src/test/samples</dir>
266 <!-- Used for linking to JDK, default: 6 -->
269 … <!-- Do not output deprecated members, applies globally, can be overridden by packageOptions -->
271 …<!-- Emit warnings about not documented members, applies globally, also can be overridden by packa…
273 <!-- Do not create index pages for empty packages -->
276 <!-- See platforms section of documentation -->
281 <!-- Short form list of sourceRoots, by default, set to ${project.compileSourceRoots} -->
286 <!-- Full form list of sourceRoots -->
290 <!-- See platforms section of documentation -->
295 …<!-- Specifies the location of the project source code on the Web. If provided, Dokka generates "s…
296 for each declaration. -->
299 <!-- Source directory -->
301 <!-- URL showing where the source code can be accessed through the web browser -->
303 <!--Suffix which is used to append the line number to the URL. Use #L for GitHub -->
308 <!-- No default documentation link to kotlin-stdlib -->
311 …<!-- Allows linking to documentation of the project's dependencies (generated with Javadoc or Dokk…
314 … <!-- Root URL of the generated documentation to link with. The trailing slash is required! -->
315 <url>https://example.com/docs/</url>
316 <!-- If package-list file located in non-standard location -->
317 <!-- <packageListUrl>file:///home/user/localdocs/package-list</packageListUrl> -->
321 <!-- Allows to customize documentation generation options on a per-package basis -->
324 <!-- Will match kotlin and all sub-packages of it -->
327 <!-- All options are optional, default values are below: -->
329 <!-- Emit warnings about not documented members -->
338 …ven example project](https://github.com/JetBrains/kotlin-examples/tree/master/maven/dokka-maven-ex…
344 The Ant task definition is also contained in the dokka-fatjar.jar referenced above. Here's an examp…
348 <typedef resource="dokka-antlib.xml" classpath="dokka-fatjar.jar"/>
358 * `outputDir` - the output directory where the documentation is generated
359 * `outputFormat` - the output format (see the list of supported formats above)
360 …* `classpath` - list of directories or .jar files to include in the classpath (used for resolving …
361 …* `samples` - list of directories containing sample code (documentation for those directories is n…
362 …* `moduleName` - the name of the module being documented (used as the root directory of the genera…
363 * `include` - names of files containing the documentation for the module and individual packages
364 * `skipDeprecated` - if set, deprecated elements are not included in the generated documentation
365 * `jdkVersion` - version for linking to JDK
366 * `impliedPlatforms` - See [platforms](#platforms) section
367 …* `<sourceRoot path="src" platforms="JVM" />` - analogue of src, but allows to specify [platforms]…
368 …ons prefix="kotlin" includeNonPublic="false" reportUndocumented="true" skipDeprecated="false"/>` -
369 Per package options for package `kotlin` and sub-packages of it
370 * `noStdlibLink` - No default documentation link to kotlin-stdlib
371 …ocumentationLink url="https://example.com/docs/" packageListUrl="file:///home/user/localdocs/packa…
372 …linking to external documentation, packageListUrl should be used if package-list located not in st…
373 …* `cacheRoot` - Use `default` or set to custom path to cache directory to enable package-list cach…
378 …ownload the [Dokka jar](https://github.com/Kotlin/dokka/releases/download/0.9.10/dokka-fatjar.jar).
381 java -jar dokka-fatjar.jar <source directories> <arguments>
385 * `-output` - the output directory where the documentation is generated
386 * `-format` - the [output format](#output-formats):
387 …* `-classpath` - list of directories or .jar files to include in the classpath (used for resolving…
388 …* `-samples` - list of directories containing sample code (documentation for those directories is …
389 …* `-module` - the name of the module being documented (used as the root directory of the generated…
390 * `-include` - names of files containing the documentation for the module and individual packages
391 * `-nodeprecated` - if set, deprecated elements are not included in the generated documentation
392 * `-impliedPlatforms` - List of implied platforms (comma-separated)
393 …* `-packageOptions` - List of package options in format `prefix,-deprecated,-privateApi,+warnUndoc…
394 * `-links` - External documentation links in format `url^packageListUrl^^url2...`
395 * `-noStdlibLink` - Disable documentation link to stdlib
396 …* `-cacheRoot` - Use `default` or set to custom path to cache directory to enable package-list cac…
401 * `html` - minimalistic html format used by default
402 * `javadoc` - Dokka mimic to javadoc
403 * `html-as-java` - as `html` but using java syntax
404 * `markdown` - Markdown structured as `html`
405 * `gfm` - GitHub flavored markdown
406 * `jekyll` - Jekyll compatible markdown
407 …* `kotlin-website*` - internal format used for documentation on [kotlinlang.org](https://kotlinlan…
424 Dokka uses Kotlin-as-a-service technology to build `code model`, then processes it into `documentat…
427 Each node has semantic attached, e.g. Value:name -> Type:String means that some value `name` is of …
431 1. Member - reference means that target is member of the source, form tree.
432 2. Detail - reference means that target describes source in more details, form tree.
433 3. Link - any link to any other node, free form.
439 ### Rendering Docs
441 When we have documentation model, we can render docs in various formats, languages and layouts. We …
443 * FormatService -- represents output format
444 * LocationService -- represents folder and file layout
445 * SignatureGenerator -- represents target language by generating class/function/package signatures …
478 * "Gradle Test Runner" should be selected in the "Run tests using" drop-down
480 * Note: After closing and re-opening the project, IDEA may give an error