Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JSDOC for enums #273

Open
MagMar94 opened this issue Sep 19, 2023 · 0 comments
Open

JSDOC for enums #273

MagMar94 opened this issue Sep 19, 2023 · 0 comments

Comments

@MagMar94
Copy link

C# documentation on enums are missing.

An example:

public enum Coffee
{
    /// <summary>
    /// A regular filter coffee.
    /// </summary>
    Black = 1,
    /// <summary>
    /// A coffee with one or two espresso shots and topped with hot water.
    /// </summary>
    Americano = 2
}
export enum Coffee
{
    Black = 'Black',
    Americano = 'Americano'
}

The documentation of the types is not included when generating the enum. I would expect something like this:

export enum Coffee
{
    /**
    * A regular filter coffee.
    */
    Black = 'Black',
    /**
    * A coffee with one or two espresso shots and topped with hot water.
    */
    Americano = 'Americano'
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant