Next: , Previous: Examples, Up: Documenting Your Code


3.17 Version

The Version header enables to add version information into the documentation of an element.

     Example: Adding version informations  
      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    Version:
     12
     13      Deprecated since version 3.2.

A Version header can only appear once per element after all Sub Elements, Result, See Also, Note and Notes headers.