documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Instance members of objects within a namespace not in correct section

Open bpatram opened this issue 8 years ago • 5 comments
trafficstars

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:

/**
 * 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

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

bpatram avatar Mar 01 '17 05:03 bpatram

yeah same issue here

paulofaria avatar Mar 15 '17 15:03 paulofaria

Any progress here?

sergeysova avatar Mar 15 '17 18:03 sergeysova

I think the issue here is the same as https://github.com/documentationjs/documentation/issues/591 - if anyone's working on the problem, feel free to post back. If anyone's interested in helping, please do, I'd love to help onboard new maintainers! Fixing this class of error is high on my list of priorities, but I'm still trying to get enough free time to knock this out.

tmcw avatar Mar 15 '17 18:03 tmcw

Still getting this error in Feb 2020. ☹

Zearin avatar Feb 09 '20 19:02 Zearin

Consult the maintenance status: if you want this fixed, please file a PR and I'll happily review & merge it.

tmcw avatar Feb 11 '20 05:02 tmcw