In the course of the development of the next KoTlin version, JetBrains has generally uploaded the documentation tool for the programming language. The Dokka currently available as preview builds on the freshly published release candidate from Kotlin 1.4 and offers numerous assessments for the ie to HTML and Markdown. In addition, developers can integrate their own examples into the documentation.
So far, Dokka has generated static HTML pages. The current release, on the other hand, creates dynamic pages that include, among other things, a navigation area and a search function. The former lists all modules, packages and types hierarchically and allows the up and folding to the respective child elements.
Using the example of the documentation of KoTlin’s Koroutines, JetBrains will show the construction of Dokka-created dynamic HTML pages.
For multiplatform projects, the Kotlin since version 1.2 allows the Head area Badges to the individual platforms and for the generally organized content. Over a click, the associated content can be filtered out, so show and hide for the respective compile destinations. For online accessible code, references from the documentation can be created via the SourceLink option.
Markdown and Java (DOC)
For the ie in the Markdown format, Dokka has two variants on board: Dokkajektyll created Markdown Jekyll and Dokkagfm Github Flavored Markdown (GFM). For the interplay with Java, Dokka offers plug-ins for HTML and the two markdown formats written in a format that is used to Java developers and developers.
Dokka created at the request documentation that is based on Javadoc.
Among other things, the tool is suitable for access to class properties matching GET and SET methods. One step further does the Dokkajavadoc task with which the output appears in the same format as in a JavaC-created documentation for Java code.
Play meadow and module variety
Dokka integrates the Kotlin Playground, which can export simple KoTlin code snippets in the browser. If you might enrich the documentation about code samples, you can integrate them over samples = Listof and specify the methods to be displayed via @SAMPLE. The content each in sharp brackets must be replaced by the file or method names.
For projects consisting of several modules, Dokka produces a documentation for each individual module standard. About the document mlcollector task, all modules can be summarized to a central documentation. With dockahtmlmultimodule, docka for each module creates its own documentation and additional overview page linked to the module descriptions and offers a preview.
Dokka is available as a plug-in for the build tools Maven and Gradle, but is also available as a separate tool for the command line. Further details and the innovations can be found in the Kotlin blog.