Open mgithubmessier opened 7 years ago
If @desc is not explicitly used, and a description is provided in the first portion of the comment on a method, then both @param and @returns, are not documented inside of the output.
{ "destination": "./doc", "includes": [ "\\.ts" ], "excludes": [ ".*node_modules.*" ], "lint": false, "plugins": [ { "name": "esdoc-standard-plugin", "option": { "coverage": { "enable": true } } }, { "name": "esdoc-typescript-plugin", "option": { "enable": true } }, { "name": "esdoc-plugin-require-coverage", "option": { "required": 0 } } ] }
/** * methodName - some description here * @param {object} param1 - description * @return {object} description * @example example code here */ methodName(param1: object): object { return {}; }
Same with @example esdoc/esdoc#502
@example
Short summary of your issue
If @desc is not explicitly used, and a description is provided in the first portion of the comment on a method, then both @param and @returns, are not documented inside of the output.
Input data for reproducing
Codes
Screen shot of documentation
Your environment