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

Documenting constants #1383

Open
deg-basis opened this issue Jul 13, 2021 · 0 comments
Open

Documenting constants #1383

deg-basis opened this issue Jul 13, 2021 · 0 comments

Comments

@deg-basis
Copy link

Using Documentation 13.2.5 and running it through yarn with the command

"documentation build --github --markdown-toc --config documentation.yml -f html src/utils/** -o docs/jsDocumentation"

I want to document a constant. My source file has:

/**
 * Event Types section in .esf files.
 * @constant
 * @type {string}
 * @default
 */
export const SECTION_EVENT_TYPES = "eventTypes";

which, I think, matches https://jsdoc.app/tags-constant.html

But, I'm not seeing the value. Instead, I get:
image

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