esdoc / esdoc-plugins

MIT License
139 stars 74 forks source link

Typescript Plugin with Angular - Cannot avoid using @desc inside method headers #25

Open mgithubmessier opened 7 years ago

mgithubmessier commented 7 years ago

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

{
  "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
      }
    }
  ]
}

Codes

/**
 * methodName - some description here
 * @param {object} param1 - description
 * @return {object} description 
 * @example example code here
 */
 methodName(param1: object): object {
     return {};
 }

Screen shot of documentation

screen shot 2017-08-31 at 3 23 11 pm

Your environment

jan-molak commented 6 years ago

Same with @example esdoc/esdoc#502