A synopsis of what H5XYZgreat_function does

Parameters

[in]	name1	Description of IN parameter `name1`
[out]	name2	Description of OUT parameter `name2`
[in,out]	name3	Description of INOUT parameter `name3`

Returns: Returns what you always wanted

Precondition: Describe preconditions for an entity. Can be repreated.

Invariant: Describe invariants for an entity. Can be repeated.

Postcondition: Describe postconditions for an entity. Can be repreated.

Deprecated:: This was my favorite function while it lasted.

Describe the normal behavior flow of the function here.

     Make reference to other functions like this: H5Fopen().

     Make reference to formal parameters like this: \p name1

     Make reference to macros like this: #H5P_DEFAULT.

     Make reference to enumeration constants like this: #H5F_CLOSE_WEAK.

     Lists are supported:
     - mouse events
       -# mouse move event
       -# mouse click event\n
          More info about the click event.
       -# mouse double click event
     - keyboard events
          1. key down event
          2. key up event

     The distance between \f$(x_1,y_1)\f$ and \f$(x_2,y_2)\f$ is
     \f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$.

     For tables, see
     <a href="https://www.doxygen.nl/manual/tables.html">this example</a>.

This is an example of how to use the H5XYZgreat_function(). The contents of the file hello_hdf5.c will be included. More details about this example.

Note: Dear reader, ...

Attention: Colorless green ideas sleep furiously.

Warning: Don't do this at home!

Author: This function was written by an esteemed author. Repeat this command for multiple authors.

Date: Record the function's birthdate!

Since: 1.MAJOR.MINOR The 'since' command can also be used to record a function's introduction (via its initial release version).

Version: 1.MAJOR.MINOR An important event in the version history of this function. There can be multiple such events.

See also: H5XYZanother_great_function(), H5XYZnot_so_great_a_function()