Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
indextrue
titleDescription

Document configuration options of your system. Each property is defined in its own document so that it is easy to references these options from your documentation individually.

Section
titleProperties
Transclusion
documentNote Box referencing common Document Properties
idsBox

Section
level2
titleIdentifier

Define the unique identifier of the property.

Section
level2
titleComponent

A reference to the component of the system this property is part of.

Section
level2
titleMandatory

Define the property is mandatory or optional. 

Section
level2
titleType

Define the datatype of the property. 

Section
level2
titleShort Type

Define the short name of the property's datatype. 

Section
level2
titleDefault Value

Specify the default value for the property, if no value is defined explicitly. 

Section
level2
titleValue Range

Define the range of valid values for the property within the specified type. 

Section
level2
titleImplementation

Add the Identifier (e.g. URI) and reference to the implementation of the property (e.g. a reference to the Javadoc of a Java property).

Section
level2
titleSince

Specify the version of the component since when this property is valid.

Section
level2
titleDeprecated Since
Specify the version of the component since when this property is deprecated. 
Section
level2
titleUntil
Specify the last version of the component that supported this property. 
Section
level2
titleReference
Add references to information on external systems here. 

...