OVMS3-idf/docs/api/template.rst

71 lines
1.3 KiB
ReStructuredText
Raw Normal View History

Template API
=============
Overview
--------
INSTRUCTIONS: Provide overview where and how this API may be used. For large number of functions, break down description into groups.
Use the folowing heading levels:
* # with overline, for parts
* \* with overline, for chapters
* =, for sections
* -, for subsections
* ^, for subsubsections
* ", for paragraphs
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