documentationjs / documentationjs/documentation

Namespace declaration doesn't work as expected

Open
#485 5 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

Given the following input:

``` js
/**
* Utilities for client and server.
* @namespace utils
*/

/**
* Handles a WebSocket message, forwarding it to the given EventEmitter.
* @memberof utils
* @param {EventEmitter} eventEmitter EventEmitter to forward the message to.
* @param {Object} data Full message data.
* @param {Object} client Sender of the message.
*/
export function handleMessage(eventEmitter, data, client) {
// ...
}
```

The following HTML documentation output gets generated:

![](https://cloud.githubusercontent.com/assets/14854048/17306538/d4ebd76a-5830-11e6-8fb4-9986f98e2ed4.png)

I marked the unnecessarily included part with red.

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.