3.13 Annotations

With Note and Notes headers you can annotate the documentation. These notes are intended to documentation writer. They appear in the final documentation only if option --emit-notes of FPDoc is used.

     Example: Note and Notes example  
      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    Note:
     12
     13      ``Min`` needs more documenting.
     14
     15    Notes:
     16      - Add an example
     17      - Find better names for ``A`` and ``B``