projectdoc Toolbox

Document a data type for properties and codes.

ID
datatype
Suite
Since
11.2

A data type is a type for a property or a code.

Data types are typically used to document simple types like enumerations and their valid values. In case there is only one property for a given type, these values are already covered by the documentation of the property. The data type allows to document the type independent of the property or codes that use it.

Properties

The document type datatype provides the following properties:

 

Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.

Type

Organize data types by their type.

Value Range

Provide a range of valid values for the data type.

A single value can be documented by the use of the code doctype.

Implementation

Add the identifier (e.g. URI) and reference to the implementation of the data type (e.g. a reference to the Javadoc of a Java class).

Since

Specify the version since when this data type is valid.

Deprecated Since

Specify the version since when this data type is deprecated. 

Until

Specify the last version that supported this data type.

Reference

Add references to information on external systems here.

Sections

Description

Describe the data type.

Related Doctypes

Code
Describe the codes that are part of the product's API.
Property
Properties are part of the configuration options of a system.
Component
Components are part of a view on a system. A component may refer to a enclosed element or to a complete system of its own.