Lines Matching full:documentation

7 Dokka is a documentation engine for Kotlin, performing the same function as javadoc for Java.
10 and can generate documentation in multiple formats including standard Javadoc, HTML and Markdown.
56     // List of files with module and package documentation
57     // http://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation
81     impliedPlatforms = ["JVM"] // See platforms section of documentation 
97         // See platforms section of documentation 
115     // No default documentation link to kotlin-stdlib
118 … // Allows linking to documentation of the project's dependencies (generated with Javadoc or Dokka)
121         // Root URL of the generated documentation to link with. The trailing slash is required!
128     // Allows to customize documentation generation options on a per-package basis
145 To generate the documentation, use the `dokka` Gradle task:
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.
255 …     <!-- http://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation -->
276         <!-- See platforms section of documentation -->
290                 <!-- See platforms section of documentation -->
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! -->
321         <!-- Allows to customize documentation generation options on a per-package basis -->
358   * `outputDir` - the output directory where the documentation is generated
361 …* `samples` - list of directories containing sample code (documentation for those directories is n…
362 …the name of the module being documented (used as the root directory of the generated documentation)
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
370   * `noStdlibLink` - No default documentation link to kotlin-stdlib
372 …linking to external documentation, packageListUrl should be used if package-list located not in st…
379 To generate documentation, run the following command:
385   * `-output` - the output directory where the documentation is generated
388 …* `-samples` - list of directories containing sample code (documentation for those directories is …
389 …the name of the module being documented (used as the root directory of the generated documentation)
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
394   * `-links` - External documentation links in format `url^packageListUrl^^url2...`
395   * `-noStdlibLink` - Disable documentation link to stdlib
407 …* `kotlin-website*` - internal format used for documentation on [kotlinlang.org](https://kotlinlan…
417 If a member is not available for all platforms in the implied platforms set, its documentation will…
422 ### Documentation Model
424 …Kotlin-as-a-service technology to build `code model`, then processes it into `documentation model`.
425 `Documentation model` is graph of items describing code elements such as classes, packages, functio…
441 When we have documentation model, we can render docs in various formats, languages and layouts. We …
447 Basically, given the `documentation` as a model, we do this:
454     generator.generate(documentation)