[next] [prev] [prev-tail] [tail] [up]

5.3.12 example : Include an example source file.

The example tag is used to include a sample code fragment in the documentation. It must appear below an element tag. Multiple example tags may appear in an element tag.

The file attribute of the is used to specify the file name containing the example. No extension is required in the filename: if it is missing, .pp is assumed.

Example:

<element name="MyDangerousFunction">  
<descr>MyDangerousFunction is a dangerous function</descr>  
<errors>When MyDangerousFunction fails, all is lost</errors>  
<example file="ex/ex1"/>  
</element>

See also: descr (171), element (179), seealso (218)

[next] [prev] [prev-tail] [front] [up]