Skip to content

Incorrect rendering of tree in the navigation menu #103

@ahmadassaf

Description

@ahmadassaf

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions