@param with link is documented wrong #119

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

Comments

Projects
None yet
2 participants
@andy-hanson

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

This comment has been minimized.

Show comment
Hide comment
@h13i32maru

h13i32maru Oct 18, 2015

Member

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

Member

h13i32maru commented Oct 18, 2015

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

@h13i32maru

This comment has been minimized.

Show comment
Hide comment
@h13i32maru

h13i32maru Oct 18, 2015

Member

this is fixed by #105

Member

h13i32maru commented Oct 18, 2015

this is fixed by #105

@h13i32maru

This comment has been minimized.

Show comment
Hide comment
@h13i32maru

h13i32maru Oct 18, 2015

Member

I published v0.4.1 that fixed this issue.

Member

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