documentationjs / documentationjs/documentation

Module section gets weird param pulled from first function after @module tag

Open
#822 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

This code:
```
/**
* module description
* @module util
* @public
*/

// jsdoc freaks out and pulls param from the next function
// unless this useless variable is defined (uncommented)
// let a;

/**
* fn description
* @param {object} obj - my object
* @returns {object} my return value
* @memberof util
* @public
*/
function convertBuffers(obj) { }

module.exports = { convertBuffers}
```
Leads to this:
![image](https://user-images.githubusercontent.com/1479005/27427754-caa606c8-5748-11e7-84b7-b90e2f2fa7b5.png)

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.