search

tnorbye / kdoc-formatter

Reformats Kotlin KDoc comments, reflowing text and other cleanup, both via IDE plugin and command line utility
Apache License 2.0
73 stars 2 forks source link

[Feature Request] Replace `{@param name}` with `[name]` #79

Closed davidtorosyan closed 2 years ago

davidtorosyan commented 2 years ago

I see this pattern, copied from Java.

Before:

/**
 * Some summary.
 *
 * Another summary about {@param someParam}.
 */
fun foo() = Unit

Here's my requested output:

/**
 * Some summary.
 *
 * Another summary about [someParam].
 */
fun foo() = Unit

There are some other patterns like {@code, {@see, {@attr-name, {@inheritDoc}, but I'm not sure how to handle all of them.

Tested with v1.5.5 using default options.

tnorbye commented 2 years ago

This should be implemented in 1.5.7.