Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
davidtorosyan opened this issue Aug 2, 2022 · 1 comment
Closed

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

davidtorosyan opened this issue Aug 2, 2022 · 1 comment

Comments

@davidtorosyan
Copy link

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 added a commit that referenced this issue Aug 3, 2022
1.5.7 fixes the following bugs:
   - #76: Preserve newline style (CRLF on Windows)
   - #77: Preformatting error
   - #78: Preformatting stability
   - #79: Replace `{@param name}` with `[name]`
tnorbye added a commit that referenced this issue Aug 3, 2022
1.5.7 fixes the following bugs:
   - #76: Preserve newline style (CRLF on Windows)
   - #77: Preformatting error
   - #78: Preformatting stability
   - #79: Replace `{@param name}` with `[name]`
@tnorbye
Copy link
Owner

tnorbye commented Aug 3, 2022

This should be implemented in 1.5.7.

@tnorbye tnorbye closed this as completed Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants