Dokka Versions Save

Main features:

• Gradle plugin overhaul
• Autoconfiguration for sourceset for Multiplatform projects
• Kotlin 1.4.0

Improvements:

Html format:

• added left navigation search component
• improved intuitiveness of displayed cursor types (thanks to @hamza1311)
• improved presentation of some generic parameters
• made unresolved links render as text
• improved overall UI experience

Javadoc:

• implemented generating both package-list and element-list
• added index page

Reporting

• maturity warning
• handling of missing sourceset for Javadoc
• handling nothing to document
• descriptions to all Dokka tasks

Other:

• improved parsing of generic typealiases
• removed redundant type bounds from all formats

Bugs fixed:

• missing whitespace in class-like signatures - #1419
• classpath issues in very specific conditions - #1415
• missing resources on windows - #1399
• top-level functions crashing Javadoc generation - #1393 #1385
• unstable order of functions in generated documentation - #1333
• anchors on android being broken in some cases - #1230
• improperly formatted code blocks - #1346
• source tabs not displayed on Windows in html format - #1361
• stack overflow on documenting complex type constraints - #1342
• symbols defined in companion objects not being linked correctly in rare cases - #1268
• unresolved links in some cases - #1345
• missing sourcesets on non-lazily configured Android projects - #1330
• Couldn't get delegate for class error - #1341
• to many sources set bubbles after running Dokka collector - #1294
• empty packages listed in the sidebar - #1257
• suppressed files still documented - #1245

The first preview release of Dokka after a complete rewrite.

Most important features:

• Support for Kotlin 1.4.0-rc
• Safe and extensible plugin system
• New HTML format:
  • Search bar
  • Navigation tree
  • Runnable samples
  • Platform filtering
  • Linking to sources
• GFM format
• Jekyll format
• Kotlin-as-java view for all formats
• Rendering Javadoc (for all versions of JDK)
• Documentation of multimodule projects with a common index

For details see the blog post.

Changes:

• Update bundled compiler version to 1.3.61 #531
• Support Flavor-specific documentation #345
• Links to stdlib on kotlinlang don't work for dokka-maven-plugin #551
• Dokka 0.10.0 ignore unsuppresed packages in suppressed packages #521
• packageListUrl must be specified even if in default location #514
• Some API methods are private starting from 0.10.0 #534
• Dokka 0.10.0 creates links to packages with no public declarations #510
• Better error message than "List is empty" when no platform is specified in multiplatform project #511
• Implement display of Java default constructors #542
• Ignore samples. Sample import when generating runnable samples #530

Check out migration notes: here

Thanks to our external contributors:

• Xerus2000 (Janek)

Changes:

• Experimental Multiplatform Support (#322, #491, #212, #307, #391)
• Merged Android and non-Android Gradle plugin #458
• Fixed Gradle plugin does not play well with gradle-kotlin-dsl #196
• Added Include Non Public as global maven configuration option #435
• Fixed Code blocks in included markdown aren't parsed correctly #433
• Fixed NPE in Javadoc generation #450
• Fixed Markdown underscore emphasis in outFormat html #182
• Fixed Self-closing <p/> tag causing removal of link #369
• Added documentation for the Gradle Kotlin DSL #359
• Fixed problems with dokkaFatJar resolution (#332, #296, #462)
• Fixed using sourceRoot results in empty index.html #496
• Fixed incorrect parsing of https urls in KDoc links #405
• Fixed +includeNonPublic in CLI #481
• Fixed Dokka fails with Javadoc format and nested Java annotations #490
• Fixed CCE in html-as-java mode #455
• Fixed CCE in Javadoc output mode #477
• Fixed rendering for parameter type in Javadoc #465
• Fixed Javadoc fails when documenting annotations #464

Check out migration notes: here

Experimental Kotlin Multiplatform support is scheduled for 0.9.19

Thanks to our external contributors:

• Robert Stoll
• Dominik Schürmann
• Tiem Song
• Tim McCormack
• Ivan Canet
• Paul Merlin
• Douglas Sigelbaum
• Sean McQuillan

Changes:

• fixed fat JAR resolution in Gradle plugin #316

• fixed constructor tag #300

• fixed preserve newlines in javadoc code blocks #409

• fixed visibility modifier for protected property getters and setters #342

• fixed missing parameters on Javadoc output on Java classes #343

• removed duplicate copies of parameters in generated docs for primary constructors #341

• fixed nullable left off function type parameter with default value #328

• fixed failing of Dokka plugin on Gradle 5.0 #388

• added instructions for configuring Dokka in IDEA #386

• fixed annotatedProperty test #426

• added an ability to disable link to Java documentation #188

• added type safe counterparts to Closure taking methods on Gradle DokkaTask #358

• fixed "Can't find node by signature not implemented for value-parameter." #278

• use canonicalPath instead of absolutePath for srcLink #289

• updated readme.md #399, #441, #443

• created FAQ

• fixed nullability annotations in Javadoc #446

• updated bundled kotlin-compiler to 1.3.20-dev-564 https://github.com/Kotlin/dokka/commit/f640397b6395d00783d476dfa5a082a02fc9d924

• refactored maven-plugin build https://github.com/Kotlin/dokka/commit/b3b3058ca1958f0b34559143b73bd98ce53e9c11

• fixed constant values for java https://github.com/Kotlin/dokka/commit/b0310f8f3e242ffc64c56e8fd95710b25b37dfff

• formated javadoc: vararg arguments are represented as single arg #361

• added type safe counterparts to Closure taking methods on Gradle DokkaTask #358

• excluded internal visibility modifier from summary, fixed exclusion logic https://github.com/Kotlin/dokka/commit/a18952be525f9683b23fc05a489cefc86a0bd11f

• fixed parameter rendering in asJava mode https://github.com/Kotlin/dokka/commit/0485472951134685c434d148b6fe5b6393217023

• introduced option to enable/disable jdk linking https://github.com/Kotlin/dokka/commit/bf03146a10c601367d5401c7afa8ba7de759ebde https://github.com/Kotlin/dokka/commit/069caa29d344ace3237552e1d30b62cee7794bae https://github.com/Kotlin/dokka/commit/23861925232505dbd70344a1d690f2475bb022e8

• added more detailed signature on class page https://github.com/Kotlin/dokka/commit/f5746c40cbb44204edd137b3183ef0d04958047b

• added support for constants in as java mode https://github.com/Kotlin/dokka/commit/633fda36403e8c5483054737d285dd01b5c190bb

• fixed local links resolved in incorrect context https://github.com/Kotlin/dokka/commit/4301503416ed45783a81250295adf4b5a86c4280

• fixed inbound links to enum entries https://github.com/Kotlin/dokka/commit/e38d83905ff706b2d656f12896a6905f5a0729d7

• fixed relative uri's generation https://github.com/Kotlin/dokka/commit/6361dd32aaf567c8e03e4aa63006193dc67cca7b

• fixed resolution of inbound links to constructors in Javadoc [commit] (https://github.com/Kotlin/dokka/commit/3c6be4a1dbbcfec5e5438452f54857cce86d0d17)

• added support for external link resolution in JavadocParser https://github.com/Kotlin/dokka/commit/b00dabc4c53a71f745c29a135541b02f8dd7d266

• added type info to param and return section in javadoc https://github.com/Kotlin/dokka/commit/a50de81d3d0ce88d2fd8e91a55b203ba49e66eb1

• added support for implicit sections inheritance https://github.com/Kotlin/dokka/commit/74b228108445a8a9024b6892f6562d77c658fc64

• fixed resolution of package links https://github.com/Kotlin/dokka/commit/ee0b640ad5c4a8cc1b65403dc2c48e7723b8f53a

• added support for {@inheritDoc} including grand inheritance and skip levels https://github.com/Kotlin/dokka/commit/a16ae6c02e1ec7270fb161c63908b5b3831bce8e

• fixed resolution of links in Javadoc https://github.com/Kotlin/dokka/commit/6cfaf04a6a0a34299d3a39803322b2eea2afbaac

• fixed structure of content paragraphs in Javadoc parser https://github.com/Kotlin/dokka/commit/57a6bb55ddafbde4eab7c1c4344fff3ad3f0fe1f

• fixed generation of superclass sequence https://github.com/Kotlin/dokka/commit/9539284e5dd72e2676dc5d656b78f21c1c7035ee

• added logic for inherited constants https://github.com/Kotlin/dokka/commit/54874733ff84998d26e21b57384ad3b2ca151fc2

• fixed checking belonging to public API https://github.com/Kotlin/dokka/commit/27deff9e3f8bb2190115f2e5f68f859f46af11a3

• stabilized signatures to fix linking from Java to Kotlin https://github.com/Kotlin/dokka/commit/a3f16fd75c200020465f79563ca58b2833236865

• made possible to group extensions by receiver https://github.com/Kotlin/dokka/commit/3e8448bf5d3f00cfaa7d4d6b4fbbf678aebc37b7

• added inbound links in java layout html https://github.com/Kotlin/dokka/commit/71ef970eacfab2fd948ab3fba9aa01808cb7b211 https://github.com/Kotlin/dokka/commit/87705bf24f6f7e541dbdb14c44e00d0b90a81f37

• added support for constants from Java in Kotlin-as-Kotlin mode https://github.com/Kotlin/dokka/commit/85d2ea3a100001d3e5555786202e64ef3ea1679e

• added support for propagating inherited extensions from libraries https://github.com/Kotlin/dokka/commit/1391dcca35a871881420c53755fed08bf47e4087

• added support for deep inheritance with external classes https://github.com/Kotlin/dokka/commit/c776aaab9af80987e3c073a40f92de748dbd38ca

• made possible to generate signatures on output format side https://github.com/Kotlin/dokka/commit/63ab561b66974c52a7d13e0823bf94329c0cd7f7

• Fix suppression of generated files for new Android Gradle Plugin #308
• Fix the wrong URL for external elements in packages with upper case in Dokka format #285
• Fix link resolution context for inherited Kdoc #229
• Fix Dokka Maven Plugin to work on JDK9 #272
• Fix CCE in getting sourcePsi while Javadoc generation #287, thanks to @Nexcius
• Fix not found node for external enum items #274
• Fix early resolution of classpath #282
• Remove unnecessary report logging in Javadoc generator #291, thanks to @lukasniemeier-zalando

Internals

LocationService removed, and all logic of path calculations was moved to NodeLocationAwareGenerator which implemented by FileGenerator

FormatDescriptor now can bind its own services, as it has access to output & analysis module Binder By default, there is a hierarchy of some abstract base format descriptors, which provides an interface of required services

• Bundled kotlin compiler updated to 1.2.40-dev-529
• #251 Fixed suboptimal (non-incremental) input properties for Gradle tasks
• #252 Fixed crash when class folders are on the classpath
• #265 Fixed Gradle plugin compatibility with Kotlin 1.2
• #243 Renamed reportNotDocumented to reportUndocumented in the Gradle plugin
• #128 Added task option to suppress an entire package
• #220 Fixed Dokka running under JDK9
• #174 Fixed wrong link in the last breadcrumbs item
• #205 Fixed links to Companion static methods with parameters do not work in javadoc format
• #224 Filtered out Android generated classes from docs
• #186 Fixed Gradle plugin task does not execute after source updates
• #228 Fixed Multi-line indented code block rendering to HTML
• #226 Fixed Gradle plugin includeNonPublic not working as documented
• #218 Made classpath configuration option Iterable<File>
• #219 Unbundled kotlin-stdlib & kotlin-reflect from Gradle plugin
• #225 Fixed exception when using packageOptions in Gradle plugin

Get artifacts at https://bintray.com/kotlin/dokka/dokka/0.9.16

Fixed incompatibility with Gradle 4.5+ (#265)

Dokka now not compatible with Gradle >= 3.2, < 3.5

Artifacts

https://bintray.com/kotlin/kotlin-eap/dokka/0.9.16-eap-3

Artifacts available at https://bintray.com/kotlin/kotlin-eap/dokka

• Bundled Kotlin compiler updated to 1.1.3
• (Gradle) processConfigurations now deprecated, new configuration mechanism kotlinTasks added.
• (#168) Compatibility with Android Build Tools 3.0.0-alpha3+
• When Gradle plugin dokka-android used Android Reference now linked by default.
• (#171) Fixed parameters formatting is broken in 0.9.14
• (#167, KT-18213) Fixed StringIndexOutOfRange for Markdown reference style links.
• Added opt-in caching of package-list's, see cacheRoot in the docs.