The Talon Manual

Versions Compared

Key

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

...

Most model elements can be documented by supplying a child <documentation> element or doc attributes. The documentation added to the model is used to generate javadoc in the generated source code.

XML

Code Block
languagexml
linenumberstrue
<model xmlns="http://www.neeveresearch.com/schema/x-adml" 
       xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance"
       namespace="com.example" defaultFactoryId="1">
  <messages>  
    <message name="Message" factoryid="1" id="1" doc="Brief Documentation">
		<!-- Specifying a nested documentation element with brief attribute overrides 
             brief doc parent attribute.
        -->
        <documentation brief="Brief Documentation Overridden">
		    Full documentation
        </documentation>
        <field name="myIntField" type="Integer" doc="A sample integer field"/>
    </messsage>
  </messages>
</model>

...