esdoc / esdoc

ESDoc - Good Documentation for JavaScript
https://esdoc.org
MIT License
2.74k stars 205 forks source link

Problem with @const and @private tags #458

Open adilek opened 7 years ago

adilek commented 7 years ago

Make sure these boxes are checked before submitting your issue - thank you! (If your issue is neither a both bug nor a request, please write in a free style)

Short summary of your issue

I am following the Google JavaScript Style Guide (https://google.github.io/styleguide/jsguide.html#jsdoc-tags). Trying to document the locally assigned this.config_ parameter. But it fails if I use @private @const together. It is solved when I remove the @const part. Additionally on documentation it is shown only * (asterisk) symbol instead of description.

Input data for reproducing

Configuration

{
  "source": "./",
  "destination": "./docs",
  "excludes": ["node_modules"],
  "plugins": [{"name": "esdoc-standard-plugin"}, {"name": "esdoc-node"}]
}

Codes

...
/** @private @const {!JSON} xx configuration values */        
this.config_ = config;
...

Screen shot of documentation

// attach a image into here

Exception output (if possible)

Log

/path/file.js
36|         /** @private @const {!JSON} xx configuration values */        
37|         this.config_ = config;

Screen shot of documentation

// attach a image into here

Your environment

adilek commented 7 years ago

Worked in this way:

        /**
         * Configuration values
         * @const
         * @private
         * @type {!JSON}
         */
        this.config_ = config;