1.5.0 Alpha

Kotlin compiler upgraded to 1.5.0

Fixes:

Make module name optional in CLI (#1850)
Fix line separator issues (#1887)
Fix preserving spaces in Javadoc comments (#1923)
GFM renderer: sanitize line ends (#1936)
Fix rendering html in briefs (#1931)
Fix code blocks on Extension Points page (#1948)
Remove extra dash (#1968)
Don't use older dir from previous runs in versioning (#1963)
Change jekyll links to be .html (#1990)
Fix Gradle plugin application (#2000)

Added features:

Add a supertype for leaf dokka tasks that defines dokkaSourceSets (#1891)
Add ability to specify older versions as a list of files (#1890)
Cachable Gradle task (#1905)
Multilanguage docs inheritance (#1951)
Logging levels in CLI (#1976)
Flatten multi-module structure (#1980)

Special thanks to external contributors: @rnett, @msink, @zsmb13, @rachelcarmena and @hfhbd

1.4.32 Alpha

Fixes:

• Fix configuration for suppressing obvious functions (#1789)
• Fix visibility on enum entry property (#1828)
• Fix missing annotations in GFM and unresolved static imports (#1845)

Added features:

• Reintroduce multimodule documentation (#1804)
• Compiler bump to 1.4.32 (#1818)
• Suppress inherited members (#1814)
• Bump kotlinx.html to 0.7.3 (#1819) (requires adding "https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven" repository)
• Add ability to document generated files (#1832)
• Handle html in KDoc (#1805)
• Make anchors stable (#1851)

Special thanks to external contributors: @AzimMuradov and @hfhbd

1.4.30 Alpha

In this release we focused on improving multi-module experience that would allow links, search and navigation to be rendered for the whole project rather than independent modules. We have also updated the compiler to 1.4.30 and introduced the versioning plugin for the multi module, that lets users generate documentation for each version incrementally and switch between them on the main page.

Breaking changes

• Dokka multi module no longer uses generic dokka${format} task but rather dokka${format}Partial where format is the desired output format like html or gfm

Improvements and bug fixes

• JvmName support #1675
• Use Maven directly to download additional dependencies #1644 thanks @adangel
• Fix docs on DProperty #1671
• Refactor ContentTable builder and fix GFM table rendering #1682
• Versioning #1654
• Footer customisation #1691
• Resolve Trove issue #1715
• Fix incorrect DRI conversion in KotlinAsJava modes for nested definitions #1701
• JvmOverloads (#1712) and add detection of JvmSynthetic (#1718) thanks @bishiboosh
• Annotations for parameters #1710
• Fix links to method parameters from documentation #1713
• Fix displaying default Java visibility #1738
• Add legacy KotlinWebsite format to recognized link formats #1750
• Fix parameters in CLI and bump kotlinx.cli #1755
• Suppress tag support #1742
• Add ability to suppress obvious functions like equals, toString #1758
• Make Gradle plugin use api instead of implementation for dokka-core #1771

1.4.20 Alpha

Breaking changes

• prefix was replaced by matchingRegex #598, thanks @martinbonnin

Improvements and bug fixes

• Dokka is now build using Kotlin 1.4.20
• javadoc now handles @inheritDoc annotation #1608
• breadcrumbs improvements in html format #1590
• functions and properties can be divided into inherited and declared #1535
• argument order is now preserved #1619, thanks @gzoritchak
• page navigation now has correct height on Safari #1633

1.4.10.2 Alpha - Improvements and bugfixes

This release is focused mainly on polishing features that were already present in Dokka

Improvements:

• Created "On this page" component in the HTML format to allow quicker navigation through long pages - #1504
• Javadoc will now inform when it is misconfigured with multiple sourcesets - #1457
• Created a Java-friendly API for plugins - #1495
• CLI module name is now optional with default value - #1533
• Added parsing of package-info in Java sources - #1528
• Translators now run in parallel #1506
• Added better handling of functional types in rendered output - #1483
• Added default values for primitive properties. Added presenting default values in signatures - #1489
• Types are now distinguished from functions in the navigation #1555
• Multiple improvements to HTML format (shorter docs on list pages, signature placement) - #1529
• Set aether authn when getting artifacts - #1512
• Added separate pages for properties - #1494
• Made logo replaceable - #1488
• GFM now supports anchors - #1442

Bugfixes:

• Handling of multiple authors - #1539
• Merging documentations of modules and packages - #1480
• Parsing strikethrough - #1397
• Escape special characters in file names - #1481
• Fix multiline links in Javadoc and wrong linebreaking of <pre> bodies #1518
• Fix vararg signatures - #1516
• Fix rendering of comment tables - #1560
• Escape urls in anchors - #1519
• Hide derived members that are not public - #1459

1.4.10 Alpha - Mobile friendly html format

Main features:

• The New HTML format is much more mobile-friendly - #1279
• Kotlin 1.4.10

Improvements:

Javadoc:

• added subclasses page
• added deprecated page

Other:

• added favicon in HTML format
• simplified where documentation for modules is being searched for - #1265

Bugs fixed:

• Asterisks in KDoc cause the chunk of text to be ripped off - #1368
• Missing variance in classlike signatures - #1384
• NullPointerException on images - #1424
• Javadoc version number is always 0.0.1 - #1406
• Codeblocks from package markdown are not displayed in HTML - #1371
• Change substituting typealiases with actual types - #1447
• NotImplementedError after migrating from 0.10.1 to 1.4.0-rc-24 - #1255
• Kotlin as Java should translate type aliases - #1115
• Show fully qualified name for typealias target coming from different package - #950

1.4.0 Alpha - Gradle plugin overhaul

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

1.4.0-rc

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.

0.10.1

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

0.10.0

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