Products         News         Downloads         Licensing         Shop         Support    

 DocFlex Technology
Overview
Features
Documentation
 DocFlex/XML
Overview
Features
Documentation
XSDDoc
Features
Organization
Examples
Templates
Subtemplates
Parameters
FAQ
WSDLDoc
Integrations
Bundles
 DocFlex/Javadoc
Overview
Documentation
Basic Templates
JavadocPro
Examples
Tutorials
 DocFlex/Together
Overview
Examples
Basic Templates
Documentation
Tutorials
 Try
Downloads
Registration
Trial License
 Use
Licensing
Shop
Support
 Company
News
Products
Customers
About Us
Imprint
Legal
Contact
Links
 

DocFlex/XML - XSDDoc - Parameters

About XSDDoc parameters

Parameter Tree


“Details | Overview Summary” parameter group

This parameter group controls the content of the Overview Summary documentation block.

Parameter/Group

Name / Type / Description

Title

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:

Copied from the value of Documentation Title parameter.
See Also Parameters:

Namespace Summary

doc.overview.namespaces : boolean

Specify whether to generate the Namespace Summary section.

Sorting

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.

Schema Summary

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.

Nested Parameters:
Specify which details are to be shown about each XML schema.

Sorting

doc.overview.schemas.sorting : boolean

Specify how the Schema Summary is sorted.

The exact meaning of this parameter is the same as of “Generate Details | Sorting | Schemas” parameter, from which it also inherits its default value.

Annotation

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 found by the following path:

xs:schema/xs:annotation/xs:documentation
Multiple <xs:documentation> elements produce multiple sections of the annotation text.

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.

Schema Profile

doc.overview.schemas.profile : boolean

Specifies whether to generate the Schema Profile section, which shows the general summary information about the component.

Nested Parameters:

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

Copyright© 2003-2014 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.