Parameter/Group |
Name / Type / Description |
|
Type Definition Detail
|
doc.comp.type : boolean
Specify whether to generate the
Type Definition Detail
section.
Applies To:
- Elements
- Global Attributes
- Simple Types
- Complex Types
|
|
Generate For
|
doc.comp.type.for
The parameters in this group allows you to specify exactly for which components the
Type Definition Detail
section must be generated.
|
|
Elements With Types
|
doc.comp.type.for.element.type : enum {"anonymous", "any", "none"}
Specify when the Type Definition Detail
section should be generated for element components.
Possible Choices:
-
"anonymous"
-
The type details will be generated only in the case of an anonymous type.
(The anonymous type is the one that is defined directly within the definition of the element component.)
This is the default setting because the (non-anonymous) global types are supposed to be documented separately.
-
"any"
-
The definition of any element type (both global and anonymous) will be documented along with the element component.
-
"none"
-
Do not document the element type definition.
Applies To:
Elements
|
|
Attributes With Types
|
doc.comp.type.for.attribute.type : enum {"anonymous", "any", "none"}
Specify when the Type Definition Detail
section should be generated for global attribute components.
Possible Choices:
-
"anonymous"
-
The type details will be generated only in the case of an anonymous type.
(The anonymous type is the one that is defined directly within the definition of the attribute component.)
This is the default setting because the (non-anonymous) global types are supposed to be documented separately.
-
"any"
-
The definition of any attribute type (both global and anonymous) will be documented along with the attribute component.
-
"none"
-
Do not document the attribute type definition.
Applies To:
Global Attributes
|
|
Global Types
|
doc.comp.type.for.type : boolean
Specify whether to generate the
Type Definition Detail
for a global type component.
Applies To:
- Simple Types
- Complex Types
|
|
Type Derivation Tree
|
doc.comp.type.deriv.tree : boolean
Specify whether to generate the
Type Derivation Tree
summary, which graphically depicts how this type was derived from the most basic types.
|
|
Annotation
|
doc.comp.type.annotation : boolean
Specify whether to include the type annotation.
Applies To:
- Elements
- Global Attributes
(In the case of a simple/complex type component,
the type annotation is already present in the component's
Annotation section.)
See Also:
“Processing | Annotations” parameter group,
where you can specify how annotations are processed and displayed.
|
|
Simple Content Derivation
|
doc.comp.type.deriv.simpleContent : enum {"local", "full", "none"}
Specify whether to generate the details about the derivation of the simple content datatype
described by this type (including all facets and annotations).
Possible Choices:
-
"local definition only"
-
Document the simple content derivation specified only within the definition of the given component itself
(i.e. the one being documented in this
Component Documentation).
-
"full"
-
Document the entire simple content derivation tree produced from all known XML schema components involved.
-
"none"
-
Do not document the derivation of simple content.
Applies To:
- Simple Types
- Complex Types (with simple content only)
Nested Parameters:
Specify if certain features should be included in the type derivation details
(e.g. full facet details, additional annotations)
|
|
Facets
|
doc.comp.type.deriv.simpleContent.facets : boolean
Specify whether to show facets
specified in each derivation step.
You may want to disable documenting every facet specified during the type derivation
because all actual facets that restrict the component value/content may be already shown in the
Simple Content Detail
section (some facets specified later may override those specified earlier).
See Also Parameter:
Details | Component Documentation | Simple Content Detail | Restrictions
|
|
Annotations
|
doc.comp.type.deriv.simpleContent.annotations : boolean
Specifies whether the datatype derivation details should include all
annotations
(e.g. facet annotations).
|
