| commit | a187baa606f1dd6ce63bc38247f4b5331d78f42b | [log] [tgz] |
|---|---|---|
| author | Dmitry Jemerov <yole@jetbrains.com> | Tue Feb 10 19:09:19 2015 +0100 |
| committer | Dmitry Jemerov <yole@jetbrains.com> | Tue Feb 10 19:09:19 2015 +0100 |
| tree | 4d4290b107ae85ce735756bc04c21c812870d86d | |
| parent | 550efc262fbd678da3d08972280b41e666c68065 [diff] |
consider ContentNodeLink nodes to be equal if they point to nodes with the same name (so that links to parameters with the same name in different overloads would still allow grouping)
Dokka is documentation engine for Kotlin, performing the same function as javadoc for Java.
NOTE: It is work in progress both on compiler side and this tool. Do not base your business on it. Yet.
Dokka uses Kotlin-as-a-service technology to build code model, then processes it into documentation model. Documentation model is graph of items describing code elements such as classes, packages, functions, etc.
Each node has semantic attached, e.g. Value:name -> Type:String means that some value name is of type String.
Each reference between nodes also has semantic attached, and there are three of them:
Member & Detail has reverse Owner reference, while Link's back reference is also Link.
Nodes that are Details of other nodes cannot have Members.
When we have documentation model, we can render docs in various formats, languages and layouts. We have some core services:
Basically, given the documentation as a model, we do this:
val signatureGenerator = KotlinSignatureGenerator() val locationService = FoldersLocationService(arguments.outputDir) val markdown = JekyllFormatService(locationService, signatureGenerator) val generator = FileGenerator(signatureGenerator, locationService, markdown) generator.generate(documentation)
Dokka docs are built with Dokka. Yes, we bootstrap and dogfood :)
Documentation can be generated in various mark-up formats.
Place documentation in different file structure. All links are relative regardless of structure.
Output symbol declarations in different languages.
KDoc is a flavour of markdown with symbol processing extensions.
name (markdown style)name (Kotlin string interpolation style), or ${java.lang.String} for longer referencesname, e.g. param doc