Skip to content

@param with link is documented wrong #119

@andy-hanson

Description

@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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions