@group module

Creates a DocObject without a generated page that can be linked to and with parent inherently set to the current DocObject.

Set the parent of other DocObjects to the group NAME for better hierarchical organization in places like navigation menus.

@group NAME [ORDER] TITLE

Parameters

  1. NAME {String}:

    Unique name of this group DocObject.

  2. ORDER {Number}:

    Used to order this DocObject in relation to other DocObjects sharing the same parent.

  3. TITLE {String}:

    Used for display purposes, such as links and headers.

Use

The @group tag below would create a new DocObject with parent inherently set to the my-module DocObject:

@parent api
@module {{}} my-module
@group my-module/components components

The group DocObject would have "type": "group" and "parent": "my-module":

"my-module/components": {
  "name": "my-module/components",
  "title": "components",
  "type": "group",
  "parent": "my-module",
  "description": "",
  "order": 0
}

Other DocObjects can set their parent to the group DocObject using @parent:

@parent my-module/components
@module {function} my-component