FlexDoc/XML - XSDDoc - Parameter Tree
About XSDDoc parameters
- [.]
- Generate Details
- Details
- Fragments
- Overview Summary
- All Component Summary
- Namespace Overview
- Schema Overview
- Component Documentation
- Navigation
- Show
- Processing
- Pagination
- DiagramKit
«Details | Component Documentation | Component Profile» parameter group
Parameter | Name / Type / Description |
---|---|
Component Profile |
doc.comp.profile : boolean
Specifies whether to generate the «Component Profile» section, which contains brief information about the component (such as which namespace it belongs to, where it is declared, type and content, etc.)
|
doc.comp.profile.namespace : boolean
Specify whether to show the namespace which the given component belongs to. Applies To:
|
|
doc.comp.profile.type : boolean
Specify whether to show the component type information.
This is typically the name of a simple or complex global type which is specified
in the
Applies To:
|
|
doc.comp.profile.content : boolean
Specify whether to show brief information about the element content model and attributes associated with the given component. In particular, this includes:
|
|
doc.comp.profile.abstract : boolean
Specify whether to document Applies To:
|
|
doc.comp.profile.block : enum {"any", "non_default", "none"}
Specify whether to document
Note: For global elements and complex types, when Possible Choices:
|
|
doc.comp.profile.block.value : boolean
Specify whether to show the actual value of the Notes:
|
|
doc.comp.profile.block.meaning : boolean
Specify whether to include the text explaining the meaning of the actual |
|
doc.comp.profile.final : enum {"any", "non_default", "none"}
Specify whether to document
Note: For global elements and complex types, when Possible Choices:
|
|
doc.comp.profile.final.value : boolean
Specify whether to show the actual value of the Notes:
|
|
doc.comp.profile.final.meaning : boolean
Specify whether to include the text explaining the meaning of the actual |
|
doc.comp.profile.subst : boolean
Specify whether to show the information about the substitution groups, in which this element is involved (i.e. affiliated, head or member of). This may include:
|
|
doc.comp.profile.subst.heads : boolean
Specify whether to show the list of the substitution group heads, which this element is member of. (In other words, these are the elements that this element may substitute for.)
When See Also Parameter: |
|
doc.comp.profile.subst.members : boolean
Specify whether to show the list of the members of the substitution group, which this element is head of. (In other words, these are the elements that may substitute for this element.)
When See Also Parameter: |
|
doc.comp.profile.nillable : boolean
Specify whether to document Applies To:
|
|
doc.comp.profile.defined : boolean
Specify whether to show where the component is defined (in which XML schema). For local elements, this section also shows the number of location where the particular local element is defined (or "used", in effect). For more details about how documenting of local elements works, please see: Documenting of local elements Applies To:
|
|
doc.comp.profile.includes : boolean
Specify whether to show the number of attributes and content elements that are defined directly within this component (not inherited from its ancestor components). This includes:
|
|
doc.comp.profile.redefines : boolean
Specify whether to show which component has been redefined by this component and where (see also below). Applies To:
|
|
doc.comp.profile.redefined : boolean
Specify whether to show which component redefines this component and where (see also below). Applies To:
Documenting of Redefined Components A schema component may redefine other component when it is declared within an XSD<xs:redefine> element.
When the XML schema, which is being redefined by this element, also contains a component with that name,
such a component becomes redefined.
It will be completely replaced by the redefining component within the namespace scope targeted by the schema.
The redefining component is typically based on the original component it redefines (it just extends or restricts it). Because of this, FlexDoc/XML XSDDoc will document both components. See Also: |
|
doc.comp.profile.used : boolean
Specify whether to show the number of locations where the component is used. Applies To:
|