You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// index.d.ts/** * This enumeration defines some values. * * @enum */exportdeclareconstSomeEnum: {/** * This is the auto property. */readonlyAUTO: "auto";/** * This is the manual property. */readonlyMANUAL: "manual";};
Thanks to the PR closing issue #1740, TypeDoc correctly recognises this object as an enum. Both the docstring of the enum-like object and the docstrings of its members should also be preserved.
Actual Behavior
While the docstring of the enum-like object are preserved, those of its members are not:
The docstrings for AUTO and MANUAL members (This is the auto property and This is the manual property respectively) are missing from the page.
Search terms
enum, enum-like object
Expected Behavior
Consider the following code:
Thanks to the PR closing issue #1740, TypeDoc correctly recognises this object as an enum. Both the docstring of the enum-like object and the docstrings of its members should also be preserved.
Actual Behavior
While the docstring of the enum-like object are preserved, those of its members are not:
The docstrings for
AUTO
andMANUAL
members (This is the auto property and This is the manual property respectively) are missing from the page.Steps to reproduce the bug
npm ci
npm run docs
docs
directory.Environment
The text was updated successfully, but these errors were encountered: