Skip to content
This repository was archived by the owner on Sep 6, 2021. It is now read-only.
This repository was archived by the owner on Sep 6, 2021. It is now read-only.

@apiPrivate parser returns string, causing strange data in output. #111

Closed
@nomoon

Description

@nomoon

The @apiPrivate parser currently returns a string:

function parse() {
return 'private';
}

When documentation is generated with the --private flag, this results in the following JS/JSON data in the entry:

{
    ...,
    "0": "p",
    "1": "r",
    "2": "i",
    "3": "v",
    "4": "a",
    "5": "t",
    "6": "e",
    ...,
}

Looking at other similar parsers, it seems that the correct output of the parse() function should be an object, like this:

return {
deprecated: true
};

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