documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Using a dot in parameter name causes the build and serve commands to fail

Open yvesgurcan opened this issue 6 years ago • 0 comments

If you're reporting a bug, please include input code, output documentation, a description of what you expected to happen, and what happened instead.

When I use @param and wrongly put a dot in my parameter name (such as callbacks.), running documentation build or documentation serve fails. Here is the documentation block that causes the issue:

        /**
         * @function callRuntimeCallbacks
         * @memberof LibTiMidity
         * @instance
         * @param callbacks.
         */ 

Here is the terminal output:

Screen Shot 2019-12-19 at 11 26 04 PM

I expected the command to run successfully.

  • What version of documentation.js are you using?

v12.1.4

  • How are you running documentation.js (on the CLI, Node.js API, Grunt, other?)

Node. The exact command I run is documentation build src/MidiPlayer.js -f html -o docs --config documentation.yml.

yvesgurcan avatar Dec 20 '19 07:12 yvesgurcan