You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
Describe the codes that are part of the product's API.
Description
Codes are part of log and error messages. They help users to pinpoint a problem by a unique identifier to make a lookup in the manual.
Properties
The document type code provides the following properties:
Identifier
Define the unique identifier of the code.
Component
Reference the component that uses this code.
Type
Define the datatype of the code.
Short Type
Define the short form of the datatype for the code.
Implementation
Add the identifier (e.g. URI) and reference to the implementation of the code (e.g. a reference to the Javadoc of a Java code).
Since
Specify the version of the component since when this code is valid.
Deprecated Since
Specify the version of the component since when this code is deprecated.
Until
Specify the last version of the component that supported this code.
Reference
Add references to information on external systems here.
Sections
Description
Describe the codes that are part of the product's API.
Codes
The list of codes closely related to this code and therefore attached as children to this document.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
