Wiki

Clone wiki

XALPI / DescriptionValues

Description of the XEOModel as Javadoc documentation

In order to have documentation that is useful in the API, I decided to copy the description attribute in the model, as javadoc for each getter/setter, which means that if you have the following model:

Customer.xeomodel

#!xml

<general orphan="true" version="1.0" type="object" name="Example">
 (...)
    <label>Represents a Customer that purchases items </label>
</general>
  (...)
<attributeText name="SSN">
   <label>SSN</label>
   <description>Represents the Customer's social security number</description>
</attributeText>

The generated interface for the customer is like the following:

#!java

/**
* Represents a Customer that purchases items
*/
public interface Customer {

 /**
 * Represents the Customer's social security number
 */ 
 public String getSSN();
 public void setSSN(String newSSN);
}

Which can easily be seen during development using the IDE's capabilities

Updated