documentationjs / documentationjs/documentation

Documenting constants

Open
#1,383 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

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](https://user-images.githubusercontent.com/62514146/125442304-84f1d7b5-1c54-4acb-af54-108a8ace43e3.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.