3.16 Examples

The Example header enables to include source code files into the documentation of an element. It can appear multiple times. Txt2FPDoc does not verify that the file exists.

     Example: Importing an example file  
      1  Function: Min -- Return smallest of two values.
      2
      3    Min returns the minimum of A and B.
      4
      5    Parameters:
      6      - A -- first value
      7      - B -- second value
      8
      9    See Also: <<Max>>
     10
     11    Example: 'demo_min.pas'

A Example header can only appear after all Sub Elements, Result, See Also, Note and Notes headers.