FlexDoc/XML - XSDDoc - Parameter Tree
About XSDDoc parameters
- [.]
- Generate Details
- Details
- Fragments
- Overview Summary
- All Component Summary
- Namespace Overview
- Schema Overview
- Component Documentation
- Component Profile
- Diagram
- XML Representation Summary
- Simple Content Detail
- Lists Of Related Components
- Usage / Definition Locations
- Annotation
- Type Definition Detail
- XML Source
- Attribute Detail
- Content Element Detail
- Navigation
- Show
- Processing
- Pagination
- DiagramKit
«Details | Component Documentation | Attribute Detail» parameter group
Parameter | Name / Type / Description |
---|---|
Attribute Detail |
doc.comp.attributes : boolean
Specify whether to generate the «Attribute Detail» section. Applies To:
|
doc.comp.attributes.for
The parameters in this group allow you to specify exactly for which components the «Attribute Detail» section must be generated. |
|
doc.comp.attributes.for.element : boolean doc.comp.attributes.for.complexType : boolean doc.comp.attributes.for.attributeGroup : boolean
Specify whether to generate the «Attribute Detail» section respectively for element, complex type and attribute group components. |
|
doc.comp.attributes.include
This parameter group controls which kinds of attribute declarations will be documented. |
|
doc.comp.attributes.include.local : boolean
Specify whether to document declarations of local attributes |
|
doc.comp.attributes.include.references : boolean
Specify whether to document references to global attributes |
|
doc.comp.attributes.include.wildcard : boolean
Specify whether to document the declaration of an attribute wildcard. Only one wildcard declaration per a component may be effective – the one either specified within the declaration of this component itself or inherited from its nearest ancestor. |
|
doc.comp.attributes.include.prohibitions : boolean
Specify whether to document attribute prohibitions. Only prohibitions declared directly in this component may be documented. |
|
doc.comp.attributes.include.inherited : boolean
Specify whether to document in this section the declarations of attributes inherited from other (ancestor) components.
When this parameter is selected (
If this parameter is unselected ( |
|
doc.comp.attributes.sorting : boolean
This parameter specifies how the attributes should be sorted.
When selected (
When unselected (
|
|
doc.comp.attributes.profile : boolean
Specifies whether to generate the «Attribute Profile» section, which contains the summary information about the attribute (such as its type, possible usage, default or fixed value, definition location). Nested Parameters:
|
|
doc.comp.attributes.profile.form : enum {"any", "non_default", "none"}
Specify whether to document the form of the attribute name (i.e. if it should be namespace-qualified or not). All globally declared attributes have namespace-qualified names.
For locally declared attributes, their namespace qualification is specified by the Possible Choices:
|
|
doc.comp.attributes.profile.type : boolean
Specify whether to show the attribute type information. |
|
doc.comp.attributes.profile.use : boolean
Specify whether to show the possible usage of the attribute.
More exactly, it is the value of the
'use' attribute is not specified, the default usage is optional.
|
|
doc.comp.attributes.profile.default : boolean
Specify whether to show the attribute default value. By default, this parameter is switched off when “Attribute Value | Default Value” parameter is selected. |
|
doc.comp.attributes.profile.fixed : boolean
Specify whether to show the attribute fixed value. By default, this parameter is switched off when “Attribute Value | Fixed Value” parameter is selected. |
|
doc.comp.attributes.profile.defined : boolean
Specify whether to show in which component this attribute is defined. The definition location may be different from the current component (being documented by this «Component Documentation») only when the “Attribute Detail | Include | Inherited” parameter is selected. So, some of the attributes may be those inherited from the component's ancestors. Note:
|
|
doc.comp.attributes.annotation : boolean
Specify whether to include the attribute annotation (full annotation text).
The annotation text is obtained from the
<xs:documentation> elements will produce separate sections of the annotation text.
See Also:
|
|
doc.comp.attributes.value : boolean
Specify whether to generate the information about a possible attribute value. This may include:
|
|
doc.comp.attributes.value.model : boolean
Specify whether to generate the datatype model, which shows how the attribute datatype is related to the XSD basic simple types. |
|
doc.comp.attributes.value.restrictions : boolean
Specify whether to show all actual facets that restrict a possible value allowed for this attribute. The list of actual facets is produced as the following. First, the initial facets are collected by all types starting from the type assigned to the attribute throughout the chain of all its ancestor types (both global and anonymous) until the top ancestor passed or a derivation by list or union reached. Further, the produced sequence of facets is filtered so as the facets collected earliest (that is defined in lower descendant types) remain and those overridden by them are removed. In particular:
|
|
doc.comp.attributes.value.restrictions.annotation : boolean
Specify whether to include the facet annotations. |
|
doc.comp.attributes.value.default : boolean
Specify whether to show the attribute default value.
The default value is provided by the
|
|
doc.comp.attributes.value.fixed : boolean
Specify whether to show the attribute fixed value.
The default value is provided by the
fixed attribute is searched for in the both components.
|
|
doc.comp.attributes.type : boolean
Specify whether to generate the details about the definition of the attribute type. This section may include:
|
|
doc.comp.attributes.type.for
The parameters in this group allows you to specify exactly for which attributes the «Type Detail» section must be generated. Each parameter imposes a specific condition on the attribute and its type. The «Type Detail» section is generated when the conditions by all parameters in this group are satisfied. |
|
doc.comp.attributes.type.for.attr : enum {"local", "any"}
Specify the possible scope of attributes for which the Type Detail section may be generated. Possible Choices:
|
|
doc.comp.attributes.type.for.typeDecl : enum {"anonymous", "any"}
Specify the possible scope of the attribute type declaration for which the «Type Detail» section may be generated. Possible Choices:
|
|
doc.comp.attributes.type.annotation : boolean
Specify whether to include the attribute type annotation. |
|
doc.comp.attributes.type.deriv.tree : boolean
Specify whether to generate the «Type Derivation Tree» summary, which graphically depicts how the attribute type was derived from the most basic types. |
|
doc.comp.attributes.type.deriv.simpleContent : boolean
Specify whether to generate the details about the derivation of the attribute datatype, including all facets and (possibly) annotations. Possible Choices:
|
|
doc.comp.attributes.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 attribute value may be already shown in the «Attribute Value» section (some facets specified later may override those specified earlier). See Also Parameter: |
|
doc.comp.attributes.type.deriv.simpleContent.annotations : boolean
Specifies whether the datatype derivation details should include all annotations (e.g. facet annotations). |
|
doc.comp.attributes.xml : boolean
Specifies whether to reproduce the XML source of the attribute declaration. Nested Parameters:
|
|
doc.comp.attributes.xml.box : boolean
Specifies if the reproduced XML should be enclosed in a box. |
|
doc.comp.attributes.xml.remove.anns : boolean
Specifies whether to remove all
You may want to exclude the See Also Parameters: |