Skip to content

Releases: tnorbye/kdoc-formatter

1.6.4: Change continuation indent from 4 to 3

04 Jul 16:37
03842f5
Compare
Choose a tag to compare

1.6.4

  • Switch continuation indent from 4 to 3. (IntelliJ's Dokka preview treats an indent of 4 or more as preformatted text even on a continued line; Dokka itself (and Markdown) does not.
  • Add ability to override the continuation indent in the IDE plugin settings.
  • Don't reorder @sample tags (backported facebook/ktfmt#406)

1.6.3: Compatibility with IntelliJ 2024.2, and K2 plugin compatibility

06 Jun 01:17
1531e1f
Compare
Choose a tag to compare
Merge pull request #99 from tnorbye/1.6.3

1.6.3: Compatibility with IntelliJ 2024.2 EAP and K2 compatibility

1.6.2: Compatibility with IntelliJ 2024.1

01 Feb 00:34
5956d02
Compare
Choose a tag to compare

This release updates the IntelliJ plugin to be compatible with IntelliJ 2024.1. (It also rebuilds everything with newer versions of Kotlin, IntelliJ release plugin, changelog plugin, etc.)

1.6.0: Update dependencies and minor bug fixes

23 Aug 01:14
a21125e
Compare
Choose a tag to compare

This release just picks up a couple of minor bug fixes and updates the dependencies (like Kotlin, the JDK (to 17), etc.

1.5.9: Compatibility with IntelliJ 2023.1

25 Jan 20:45
c63d0ec
Compare
Choose a tag to compare

Compatibility with IntelliJ 2023.1.

1.5.8: Bugfixes

09 Dec 02:50
d1ec377
Compare
Choose a tag to compare
  • Fixed a number of bugs:
    • #84: Line overrun when using closed-open interval notation
    • More gracefully handle unterminated [] references (for example when
      comment is using it in things like [closed, open) intervals)
    • Recognize and convert accidentally capitalized kdoc tags like @see
    • If you have a [ref] which spans a line such that the # ends up as a
      new line, don't treat this as a "# heading".
    • Make sure we don't line break at an expression starting with ">"
      since that would turn into a quoted line.
    • If you're using optimal line breaking and there's a really long,
      unbreakable word in the paragraph, switch that paragraph over to
      greedy line breaking (to make the paragraph better balanced since
      the really long word throws the algorithm off.)
    • Fix a few scenarios where markup conversion from <p> and </p>
      wasn't converting everything.
    • Allow @Property[name], not just @param[name]
    • The --hanging-indent flag now also sets the nested list indent
      (if >= 3)
  • Some minor code cleanup.

v1.5.7: Merge pull request #81 from tnorbye/1.5.7

03 Aug 18:22
629085e
Compare
Choose a tag to compare

1.5.7 fixes the following bugs and feature requests:

  • #76: Preserve newline style (CRLF on Windows)
  • #77: Preformatting error
  • #78: Preformatting stability
  • #79: Replace {@param name} with [name]

1.5.6 Override line width

29 Jul 21:00
14ec3ca
Compare
Choose a tag to compare

This release only fixes a bug in the IDE plugin: the override line width (and override comment width) settings were not working properly.

1.5.5: Bug fixes, IDE plugin improvements, line breaking tweaks

28 Jul 22:51
5b38bd7
Compare
Choose a tag to compare
  • Fixed the following bugs:
    • #53: The collapse-single-line setting does not work in the IDE
    • #69: Paragraph + list (stability), variation 2
    • #70: Multi-line @link isn't converted if there's a #
    • #71: Make plugin dynamic
    • #72: @param with brackets is not supported
    • A bug where <p> paragraphs following a blank line would be
      deleted (without leaving a blank paragraph separator)
  • Changed heuristics around optimal or greedy line breaking in list
    items and for KDoc tag and TODO-item paragraph formatting.
  • The .editorconfig support is improved. It will now pick up the nearest
    applicable .editorconfig settings for a file, but any options
    explicitly set from the command line will override the .editor config.
    • Also, the "collapse documents that fit on a single line" option,
      instead of just defaulting to true, will now use the default
      specified for the equivalent setting for Java (if set), ensuring a
      more consistent codebase. (You can also set it for Kotlin using
      ij_kotlin_doc_do_not_wrap_if_one_line, though that option isn't
      supported in the IDE or by the Kotlin plugin currently.)
  • Preliminary support for formatting line comments and block comments
    (enabled via new flags, --include-line-comments and
    --include-block-comments.)
  • Misc IDE plugin improvements
  • <pre> tags are converted into KDoc preformatted block

1.5.4: Misc bugfixes

26 Jul 18:08
3fec9a9
Compare
Choose a tag to compare

This release fixes 9 bugs filed by the ktfmt project.