2016-10-26 15:08:36 -04:00
|
|
|
Template API
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
Overview
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
INSTRUCTIONS: Provide overview where and how this API may be used. For large number of functions, break down description into groups.
|
|
|
|
|
|
2016-10-27 15:22:35 -04:00
|
|
|
Use the folowing heading levels:
|
|
|
|
|
|
|
|
|
|
* # with overline, for parts
|
|
|
|
|
* \* with overline, for chapters
|
|
|
|
|
* =, for sections
|
|
|
|
|
* -, for subsections
|
|
|
|
|
* ^, for subsubsections
|
|
|
|
|
* ", for paragraphs
|
|
|
|
|
|
2016-10-26 15:08:36 -04:00
|
|
|
|
|
|
|
|
Application Example
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
INSTRUCTIONS: Provide one or more pratical examples to demonstrate functionality of this API.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Reference
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
INSTRUCTIONS: Provide list of API memebers divided into sections. Use coresponding **.. doxygen** directices, so member documentation is auto updated.
|
|
|
|
|
|
|
|
|
|
* Data Structures **.. doxygenstruct**
|
|
|
|
|
* Macros **.. doxygendefine**
|
|
|
|
|
* Type Definitions **.. doxygentypedef**
|
|
|
|
|
* Enumerations **.. doxygenenum**
|
|
|
|
|
* Functions **.. doxygenfunction**
|
|
|
|
|
* Variables **.. doxygenvariable**
|
|
|
|
|
|
|
|
|
|
Include code snippotes to ilustrate functionality of particular functions where applicable. Skip section hearder if empty.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Data Structures
|
|
|
|
|
^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
.. Data Structures .. doxygenstruct
|
|
|
|
|
|
|
|
|
|
Macros
|
|
|
|
|
^^^^^^
|
|
|
|
|
|
|
|
|
|
.. Macros .. doxygendefine
|
|
|
|
|
|
|
|
|
|
Type Definitions
|
|
|
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
.. Type Definitions .. doxygentypedef
|
|
|
|
|
|
|
|
|
|
Enumerations
|
|
|
|
|
^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
.. Enumerations .. doxygenenum
|
|
|
|
|
|
|
|
|
|
Functions
|
|
|
|
|
^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
.. Functions .. doxygenfunction
|
|
|
|
|
|
|
|
|
|
Variables
|
|
|
|
|
^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
.. Variables .. doxygenvariable
|
|
|
|
|
|
|
|
|
|
|
