FlexDoc/XML - XSDDoc - Parameter Tree
About XSDDoc parameters
«Details | Overview Summary» parameter group
This parameter group controls the content of the «Overview Summary» documentation block.
Parameter | Name / Type / Description |
---|---|
doc.overview.title : string
Specify the title to be placed at the top of the «Overview Summary» page/block. Note: The text specified with this parameter may contain HTML tags, which will be rendered with the corresponding formatting (in both HTML and RTF). Check also that “Render embedded HTML” option of the destination output format is set for this! (It can be specified in the generator dialog.) Default Value:
|
|
doc.overview.namespaces : boolean
Specify whether to generate the «Namespace Summary» section. |
|
doc.overview.namespaces.sorting : boolean
Specify how the «Namespace Summary» is sorted. The exact meaning of this parameter is the same as of “Generate Details | Sorting | Namespaces” parameter, from which it also inherits its default value. |
|
doc.overview.schemas : boolean
Specify whether to generate the «Schema Summary» section that enumerates all documented XML schemas along with a few details about each of them.
|
|
doc.overview.schemas.sorting : boolean
Specify how the «Schema Summary» is sorted. The parameter has the following meaning:
|
|
doc.overview.schemas.annotation : enum {"first_sentence", "full", "none"}
Specify whether to include the XML schema annotation and which part of it.
The full annotation text is obtained from all
<xs:documentation> elements produce multiple sections of the annotation text.
Possible Choices:
|
|
doc.overview.schemas.profile : boolean
Specifies whether to generate the «Schema Profile» section, which shows the general summary information about the component. Nested Parameters:
|