Skip to content

Add support for grouping types #594

Open
@simonauner

Description

@simonauner

Suggestion for a new option --group which groups types (functions, events, constants etc).

Today, given JSdoc

/**
 * @constant SESSION
 */
/**
 * @event my:event
 */
/**
 * Update account data to backend. Also updates local user data if successful.
 * @methodOf platform.model.user.User
 * @param {Object} payload Payload according to spec
 * @return {Promise} Promise of new user data.
 */
 function updateAccountData(payload) {}

The output in markdown becomes


SESSION

my:event

updateAccountData


Making no visual indication that these are of different types. I suggest to add config option --group which could generate the following:


Constants

SESSION

Events

my:event

Methods

updateAccountData


Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions