Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect rendering of tree in the navigation menu #103

Open
ahmadassaf opened this issue Jan 30, 2020 · 3 comments
Open

Incorrect rendering of tree in the navigation menu #103

ahmadassaf opened this issue Jan 30, 2020 · 3 comments

Comments

@ahmadassaf
Copy link

Hello,

I am having issues understanding the rendering of the menu when I have nested modules, namespaces, etc. The usage of memberof .. etc. renders the content properly using jsdoc but not in docma.

I have a main namespace defined as:

/**
 * @namespace bmrExtension
 * @requires bmrExtension.uikit
 * @requires bmrExtension.profile
 */

And then two namespaces bmrExtension.uikit and bmrExtension.profile and modules acl and loggers defined as:

/**
 * @namespace bmrExtension.profile
 * @requires acl
*/
/**
 * @namespace bmrExtension.uikit
*/
/**
 * @module
 * @name acl
 * @memberof bmrExtension
*/
/**
 * @module loggers
 * @memberof bmrExtension
*/

The module loggers itself has members and so far everything renders nicely.

/**
 * @name reduxLogger
 * @memberof bmrExtension.module:loggers
 * @type {Function}
 */

image

Now, I want to add a new module that is a memberof the main namespace bmrExtension and has a bunch of members.

/**
 * @module stores
 * @memberof bmrExtension
 */

and then I have:

/**
 * @name contactStore
 * @memberof bmrExtension.module:stores
 * @type {Object}
 */

/**
 * @name fieldsStore
 * @memberof bmrExtension.module:stores
 * @type {Object}
 */

/**
 * @name flagsStore
 * @memberof bmrExtension.module:stores
 * @type {Object}
 */

/**
 * @name notificationsStore
 * @memberof bmrExtension.module:stores
 * @type {Object}
 */

/**
 * @name pageStore
 * @memberof bmrExtension.module:stores
 * @type {Object}
 */

/**
 * @name usersStore
 * @memberof bmrExtension.module:stores
 * @type {Object}
 */

and this is where it becomes interesting:

image

only two are nested properly, one is completely missing and two are nested wrongly.

When I try and render using jsdoc I get the correct member hierarchy:

image

Would love to hear your thoughts on this.

@ahmadassaf
Copy link
Author

Was taking a look at #58 and I have a similar observations of the rendering of items above and below the index.js. Those above are the ones with the wrong order.

image

@ahmadassaf
Copy link
Author

and as a sanity check, I've just renamed contactStore into zcontactStore and the it was added correctly to its place !

@ahmadassaf
Copy link
Author

ahmadassaf commented Jan 30, 2020

using https://github.com/onury/jsdoc-x this seem to be an issue with the parser rather than with docma. Opened onury/jsdoc-x#13 to track

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant