documentationjs / documentationjs/documentation

Instance members of objects within a namespace not in correct section

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

Description

It seems as though instance members of a class/object within a namespace are not organized correctly on the output documentation. I am running the very latest commit to date: https://github.com/documentationjs/documentation/commit/f07285a9200162908efa5dfc3076cb32d1425c6e

See example below:

```javascript
/**
* A namespace.
* @namespace MyNamespace
*/

/**
* This class has an issue since it is in a namespace
* @class FooClass
* @memberof MyNamespace
*/
class FooClass {
/**
* Function description for foo
*/
bar() {}
}

/**
* This class has no issue as it is not in a namespace
* @class BarClass
*/
class BarClass {
/**
* Function description for foo
*/
baz() {}
}
```

HTML Output:
![image](https://cloud.githubusercontent.com/assets/5579960/23447546/b41c000c-fe19-11e6-8844-2716a8c6bc80.png)

Notice how the `bar` function is not nested under its class of `FooClass`. I would expect it would be nested within the `FooClass` member of the `MyNamespace` namespace

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.