Skip to content

Document default export #387

@SimenB

Description

@SimenB

The generated documentation for a default, unnamed export, gets the header of the first argument.

I'm not familiar with JSDoc, so might just be me doing something weird.

Also, any way to properly document that it's the default, as it's not named?

And another thing while I'm here, why does parameters with default values get a = added? And why do I have to document the default value, when it's in the code? From #305 I think it should work, but it doesn't...

Sample: https://github.com/SimenB/wait-until-promise/blob/doc/API.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions