Parameter/Group

Name / Type / Description

Summary Item
doc.allcomps.item
This parameter group controls which information about a component will appear in a summary table item.

Annotation
doc.allcomps.item.annotation : enum {"first_sentence", "full", "none"}
Specify whether to include the component annotation and which part of it.
Possible Choices:

"first sentence"

Include only the first sentence of the annotation text.

"full"

Include the full annotation.

"none"

Do not include annotation.

See Also:
“Processing | Annotations” parameter group, where you can specify how annotations are processed and displayed.

Component Profile
doc.allcomps.item.profile : boolean
Specifies whether to generate the Component Profile section, which shows the general summary information about the component.
Nested Parameters:

Control what is included in the Component Profile section. These parameters are similar to those found in “Detail | Component Documentation | Component Profile” parameter group.

Sorting doc.allcomps.sorting : boolean
Specify the sorting order of components.
The exact meaning of this parameter is the same as of “Generate Details | Sorting | Components” parameter, from which it also inherits its default value.

Elements
doc.allcomps.elements : boolean
Specify whether to generate the Element Summary section.
Note:
The default value of this parameter is provided by “Generate Details | Elements” parameter.

Local Elements
doc.allcomps.elements.local : enum {"all", "complexType", "none"}
Specifies whether to include local elements in the Element Summary.

Local elements are the locally defined element components. For more information, please see: How everything is documented | Local Elements.

Possible Choices:

"all"

Include all local elements.

"with complex type only"

Include only local elements with complex types.

"none"

Do not include local elements.

Note:
The default value of this parameter is provided by “Generate Details | Elements | Local Elements” parameter.

Complex Types
doc.allcomps.complexTypes : boolean
Specify whether to generate the Complex Type Summary section.
Note:
The default value of this parameter is provided by “Generate Details | Complex Types” parameter.

Simple Types
doc.allcomps.simpleTypes : boolean
Specify whether to generate the Simple Type Summary section.
Note:
The default value of this parameter is provided by “Generate Details | Simple Types” parameter.

Element Groups
doc.allcomps.groups : boolean
Specify whether to generate the Element Group Summary section.
Note:
The default value of this parameter is provided by “Generate Details | Element Groups” parameter.

Global Attributes
doc.allcomps.attributes : boolean
Specify whether to generate the Global Attribute Summary section.
Note:
The default value of this parameter is provided by “Generate Details | Global Attributes” parameter.

Attribute Groups
doc.allcomps.attributeGroups : boolean
Specify whether to generate the Attribute Group Summary section.
Note:
The default value of this parameter is provided by “Generate Details | Attribute Groups” parameter.