All Versions
20
Latest Version
Avg Release Cycle
103 days
Latest Release
1234 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