All Versions
20
Latest Version
Avg Release Cycle
103 days
Latest Release
325 days ago

Changelog History
Page 1

  • v1.4.20 Changes

    December 03, 2020

    πŸ’₯ Breaking changes

    πŸ‘Œ 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
  • v1.4.10 Changes

    September 22, 2020

    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
  • v1.4.10.2 Changes

    October 20, 2020

    πŸš€ 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
    • 0️⃣ 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
  • v1.4.0 Changes

    September 03, 2020

    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
  • v1.4.0-rc Changes

    August 04, 2020

    πŸš€ 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.

  • v0.10.1 Changes

    February 04, 2020

    πŸ”„ 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
    • 0️⃣ Implement display of Java default constructors #542
    • Ignore samples. Sample import when generating runnable samples #530
  • v0.10.0 Changes

    October 07, 2019

    Check out migration notes: here

    Thanks to our external contributors:

    πŸ”„ 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
  • v0.9.18 Changes

    March 19, 2019

    πŸ™‹ Check out migration notes: here

    ⏱ Experimental Kotlin Multiplatform support is scheduled for 0.9.19

    Thanks to our external contributors:

    πŸ”„ 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 f640397

    ♻️ refactored maven-plugin build b3b3058

    πŸ›  fixed constant values for java b0310f8

    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
    a18952b

    πŸ›  fixed parameter rendering in asJava mode 0485472

    introduced option to enable/disable jdk linking
    bf03146
    069caa2
    2386192

    βž• added more detailed signature on class page f5746c4

    βž• added support for constants in as java mode 633fda3

    πŸ›  fixed local links resolved in incorrect context 4301503

    πŸ›  fixed inbound links to enum entries e38d839

    πŸ›  fixed relative uri's generation 6361dd3

    πŸ›  fixed resolution of inbound links to constructors in Javadoc [commit] (3c6be4a)

    βž• added support for external link resolution in JavadocParser b00dabc

    βž• added type info to param and return section in javadoc a50de81

    βž• added support for implicit sections inheritance 74b2281

    πŸ›  fixed resolution of package links ee0b640

    βž• added support for {@inheritDoc} including grand inheritance and skip levels a16ae6c

    πŸ›  fixed resolution of links in Javadoc 6cfaf04

    πŸ›  fixed structure of content paragraphs in Javadoc parser 57a6bb5

    πŸ›  fixed generation of superclass sequence 9539284

    βž• added logic for inherited constants 5487473

    πŸ›  fixed checking belonging to public API 27deff9

    stabilized signatures to fix linking from Java to Kotlin a3f16fd

    made possible to group extensions by receiver 3e8448b

    βž• added inbound links in java layout html 71ef970
    87705bf

    βž• added support for constants from Java in Kotlin-as-Kotlin mode 85d2ea3

    βž• added support for propagating inherited extensions from libraries 1391dcc

    βž• added support for deep inheritance with external classes c776aaa

    made possible to generate signatures on output format side 63ab561

  • v0.9.17 Changes

    May 21, 2018
    • πŸ›  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
    0️⃣ By default, there is a hierarchy of some abstract base format descriptors, which provides an interface of required services

  • v0.9.17-g20190326

    March 26, 2019