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
DiagramKit
Integrations
 DocFlex/Javadoc
Overview
Documentation
JavadocClassic
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 | Component Documentation | Usage / Definition Locations” parameter/group

Parameter/Group

Name / Type / Description

Usage / Definition Locations doc.comp.usage : boolean

Specify whether to generate the Usage / Definition Locations section.

Applies To:

All components

Generate For

doc.comp.usage.for

The parameters in this group allow you to select exactly for which components the Usage / Definition Locations section must be generated.

Global Elements

doc.comp.usage.for.element.global : boolean

Specifies whether to generate the Usage Locations report for global element components.

Local Elements

doc.comp.usage.for.element.local : enum {"always", "multiple", "never"}

Specifies whether to generate the Definition Locations report for local elements. (It shows all locations where a given local element is defined.)

Possible Choices:

"always"
Generate the definition locations report for all local elements.
"multiple only"
Generate this section only for unified local elements with multiple definition locations.

Note: For a single local element, the information about where it is defined will appear also in the component profile section. See parameter: “Details | Component Documentation | Component Profile | Defined

"never"
Do not generate the definition locations report.

See Also:

For more information about how local elements are documented, please see How everything is documented | Local Elements.

Complex Types
Simple Types
Element Groups
Global Attributes
Attribute Groups

doc.comp.usage.for.complexType : boolean
doc.comp.usage.for.simpleType : boolean
doc.comp.usage.for.group : boolean
doc.comp.usage.for.attribute : boolean
doc.comp.usage.for.attributeGroup : boolean

Specify whether to generate the Usage Locations report for corresponding global component types.

List Layout doc.comp.usage.layout : enum {"flow", "one_column", "two_columns", "optimal"}

This parameter controls how the list items are displayed.

Possible Choices:

"flow"
The list items will appear as a comma delimited text flow within a single paragraph.

This layout produces a very compact representation of the list. However, it may be difficult to read, particularly when some items contain spaces.

"one column"
The list will be printed in a single column: each item on a separate line.

This layout suits best for the lists containing long strings (particularly with spaces).

"two columns"
The list items will be arranged in a two-column table.

This representation suits more for the lists, whose items include strings with spaces.

However, when the list contains long strings, the two-column table may stretch far beyond the visible (printable) page width. In that case, the one-column layout suits better.

Also, the two-column layout may be not very good for big lists made of short word items (because it will occupy too much space). In that case the flow layout may fit better.

"optimal"
This choice allows for the list layout to be selected automatically during the generation so as to represent each particular list in both the most dense and readable form. (This is programmed in templates.)

Copyright© 2017 Filigris Works, Leonid Rudy Softwareprodukte. All rights reserved.