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 | Simple Content Detail” parameter/group

Parameter/Group

Name / Type / Description

Simple Content Detail doc.comp.simpleContent : boolean

Specify whether to generate the Simple Content Detail section, which shows the details of the simple content defined by (or associated with) this component.

Under the term "simple content", we mean any data that comply with one of the XSD basic datatypes (e.g. xs:string or xs:boolean). In the case of XML elements, such data may represent the content of some element. In the case of attributes, it is the attribute value.

Applies To:

  • Elements with simple content model.
  • Complex Types with simple content model.
  • All Simple Types. The simple content is exactly what a particular simple type defines.
  • All Global Attributes. The attribute value is a particular instance of simple content.
Nested Parameter Group:
Controls generation of specific details about simple content.

Restrictions

doc.comp.simpleContent.restrictions : boolean

Specify whether to show all actual facets that restrict a possible value allowed for this simple content.

The list of actual facets is produced as follows.

First, the initial facets are collected by all types starting from the lowest one (which is either this component itself, when it is a type, or the type directly assigned to this component, when it is an element or 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:

  1. All xs:pattern facets will remain, because a value allowed for the given simple content must match all of them.
  2. The xs:enumeration facets will remain those that are defined in the same type, which is nearest to the given component.
  3. All other facets will override the same facets defined in the ancestor types.
Nested Parameter:
Specifies whether to show the annotation of each facet.
See Also Parameter:
Details | Component Documentation | Type Definition Detail | Simple Content Derivation | Facets

Annotations

doc.comp.simpleContent.restrictions.annotation : boolean

Specify whether to include the facet annotations.

Default Value

doc.comp.simpleContent.default : boolean

Specify whether to show the default value assigned to the given simple content.

This applies to global element and global attribute components. The default value is specified using 'default' attribute of the XSD element defining the component.

In the case of local elements, this item may be not applicable. When an element is declared locally in several places, its default value may be different at each location, therefore, it is senseless to display here just one of those values. (For more details about documenting of local elements, please see the description of the parameter: Generate Details | Elements | Local Elements.)

Applies To:

  • Elements
  • Global Attributes

Fixed Value

doc.comp.simpleContent.fixed : boolean

Specify whether to show the fixed value assigned to the given simple content.

This applies to global element and global attribute components. The default value is specified using 'fixed' attribute of the XSD element defining the component.

In the case of local elements, this item may be not applicable. When an element is declared locally in several places, its default value may be different at each location, therefore, it is senseless to display here just one of those values. (For more details about documenting of local elements, please see the description of the parameter: Generate Details | Elements | Local Elements.)

Applies To:

  • Elements
  • Global Attributes

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