Skip to content

Parameter description not displaying in proper location for "far arrow" function #37

@samherrmann

Description

@samherrmann

Let's assume we have the following "fat arrow" function:

/**
* This is a simple fat arrow function.
* @param param1 The first parameter needed by this function.
* @param param2 The second parameter needed by this function.
*/
public myFunction = (param1: string, param2: number): void => {
    // do something here...
}

For this example, typedoc will display the description of param1 before the "Parameters" heading in the output, instead of below the param1 heading. The description for param2 is in the correct location (below the param2 heading).

If I change the above example by simply adding an empty @param declaration as shown below, then all parameter descriptions appear in the expected locations in the output.

/**
* This is a simple fat arrow function.
* @param
* @param param1 The first parameter needed by this function.
* @param param2 The second parameter needed by this function.
*/
public myFunction = (param1: string, param2: number): void => {
    // do something here...
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions