Description (element)

From JRapid

Jump to: navigation, search

description is an element, child of entity.


Contents

Description

Used for documentation generation, associated to an entity. The description element in an entity generates a text that is displayed in the help menu of the entity.

Usage

<entity name = NAME label = LABEL>
  ...
  <description>DESCRIPTION</description>
  ...
</entity>


Example

Describing an "Owner" entity.

 <entity name="owner" label="Owner" >
   ...
   <description>Is the Owner of a pet</description>
   ...
 </entity>

See also

Personal tools