documentationjs / documentationjs/documentation

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

Open
#1,300 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

**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](https://user-images.githubusercontent.com/28522282/71237600-d455b380-22b6-11ea-92b4-318e2d67578c.png)

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`.

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.