DocFlex/XML - XSDDoc - Parameters

Parameter/Group

Name / Type / Description

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.)

Applies To:

All components

Nested Parameter Group:

Controls what exactly is included in the Component Profile section.

Namespace

Specify whether to show the namespace which the given component belongs to.

Applies To:

All components

Type

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 'type' attribute of the XSD element that defines the component. For example:

<xs:element name="minExclusive" type="xs:facet">

Applies To:

• Elements
• Global Attributes

Content

Specify whether to show brief information about the element content model and attributes associated with the given component. In particular, this includes:

• The element content type, which may be: simple, complex, mixed or empty. This applies to the components:
  • Elements
  • Complex Types
  (In the case of Element Groups, the element content is always complex. Simple Types always define simple content. Other components do not define element content.)
• The number of attributes (including a wildcard attribute) associated with the given component. These are both the attributes defined within the component itself and inherited from its ancestors. This item applies to the components:
  • Elements
  • Complex Types
  • Attribute Groups
• The number of content elements (including a wildcard) associated with the given component. These are both the content elements defined within the component itself and inherited from its ancestors. This item applies to the components:
  • Elements
  • Complex Types
  • Element Groups

Abstract

Specify whether to document 'abstract' attribute of the component.

Applies To:

• Global Elements
• Complex Types

Block

Specify whether to document 'block' attribute of the component.

Note: For global elements and complex types, when block attribute is not specified, its default value is defined by the 'blockDefault' attribute of the parent <xs:schema>.

Possible Choices:

"any"

Document block attribute in any case both for the original and default value.

"non-default only"

Document block attribute only in the case when it is specified on this component. (No default value will be documented.)

"none"

Do not document block attribute.

• Global & Local Elements
• Complex Types

Specify how to document the 'block' attribute value.

Value

Specify whether to show the actual value of the 'block' attribute.

Notes:

• For global elements and complex types, when 'block' attribute is not specified on the component, its value will be taken from the 'blockDefault' attribute of the parent <xs:schema>.
• Empty or blank value will be ignored (treated as no-value)

Meaning

Specify whether to include the text explaining the meaning of the actual 'block' attribute value.

Final

Specify whether to document 'final' attribute of the component.

Note: For global elements and complex types, when final attribute is not specified, its default value is defined by the 'finalDefault' attribute of the parent <xs:schema>.

Possible Choices:

"any"

Document final attribute in any case both for the original and default value.

"non-default only"

Document final attribute only in the case when it is specified on this component. (No default value will be documented.)

"none"

Do not document final attribute.

• Global Elements
• Complex Types
• Simple Types

Specify how to document the 'final' attribute value.

Value

Specify whether to show the actual value of the 'final' attribute.

Notes:

• For global elements and complex types, when 'final' attribute is not specified on the component, its value will be taken from the 'finalDefault' attribute of the parent <xs:schema>.
• Empty or blank value will be ignored (treated as no-value)

Meaning

Specify whether to include the text explaining the meaning of the actual 'final' attribute value.

Subst.Gr

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:

• The list (or number) of elements which this element may substitute for.
• The list (or number) of elements that may substitute for this element.

Global Elements

Controls what exactly is included in the substitution group info.

List of group heads

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 false (unselected), only the number of the substitutable elements will be printed along with the link to the "May substitute for elements" section in the Element Documentation (which, when specified, shows the same list).

See Also Parameter:

Details | Component Documentation | Lists Of Related Components | Substitutable Elements

List of group members

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 false (unselected), only the number of the substituting elements will be printed along with the link to the "May be substituted with elements" section in the Element Documentation (which, when specified, shows the same list).

See Also Parameter:

Details | Component Documentation | Lists Of Related Components | Substituting Elements

Nillable

Specify whether to document 'nillable' attribute of the element component.

Applies To:

Global Elements

Defined

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: How everything is documented | Local Elements

Applies To:

All components

Includes

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:

• The number of attributes (including a wildcard attribute) defined within this component. It applies to the components:
  • Elements
  • Complex Types
  • Attribute Groups
• The number of content elements (including a wildcard) defined within this component. It applies to the components:
  • Elements
  • Complex Types
  • Element Groups

Redefines

Specify whether to show which component has been redefined by this component and where (see also below).

Applies To:

• Complex Types
• Simple Types
• Element Groups
• Attribute Groups

Redefined

Specify whether to show which component redefines this component and where (see also below).

Applies To:

• Complex Types
• Simple Types
• Element Groups
• Attribute Groups

Documenting of Redefined Components

The redefining component is typically based on the original component it redefines (it just extends or restricts it). Because of this, DocFlex/XML XSDDoc will document both components.

Used

Specify whether to show the number of locations where the component is used.

Applies To:

All global components

Details | Component Documentation | Usage/Definition Locations