@group

  • function
documentjs.tags.group  

Declares that other tags belong to a group within the current docObject.

@group name [ORDER] title

Parameters

  1. name {String}

    The unique name of the group.

  2. order {Number}Optional

    The placement of this group in the parent's list of children.

  3. title {String}

    The title that should be shown in the sidebar.

Use

For example, in myapp.md, the following will create a "Guides" grouping:

@page MyApp
@group MyApp.guides 0 Guides

And in guides/installing.md, the following will add an Installing page to the "Guides" grouping:

@page Installing
@parent MyApp.guides