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

@param with link is documented wrong #119

Closed
andy-hanson opened this issue Oct 16, 2015 · 3 comments
Closed

@param with link is documented wrong #119

andy-hanson opened this issue Oct 16, 2015 · 3 comments

Comments

@andy-hanson
Copy link

@andy-hanson andy-hanson commented Oct 16, 2015

I'm documenting this code:

/**
@param {string} x The only parameter of {@link foo}.
*/
export function foo(x) {}

It produces this warning:

warning: signature mismatch: foo src/file.js#1
0| /**
1| @param {string} x The only parameter of {@link foo}.
2| */
3| export function foo(x) {}

The documentation looks like:

import {foo} from './src/file.js'
Params:
Name    Type    Attribute   Description
.   string

The name of the parameter has become . rather than x.

The error is fixed by replacing {@link foo} with foo.

@h13i32maru
Copy link
Member

@h13i32maru h13i32maru commented Oct 18, 2015

@andy-hanson This is ESDoc bug. I will fix it. Thanks!

@h13i32maru
Copy link
Member

@h13i32maru h13i32maru commented Oct 18, 2015

this is fixed by #105

@h13i32maru
Copy link
Member

@h13i32maru h13i32maru commented Oct 18, 2015

I published v0.4.1 that fixed this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.