doc: New note with markup for the function's Doxygen document.

A new note explains the correct ReST markup for links to the functions
in the API documentation extracted by Doxygen.

Change-Id: Ifd61794445bc559485dd4034ae68897271837939
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
This commit is contained in:
Rodrigo Caballero 2015-10-13 15:31:33 -05:00 committed by Anas Nashif
commit e29545556a

View file

@ -8,6 +8,13 @@ function comments. The syntax described here is one of many that are possible.
If your development requires an option that is not described here, use it.
However, you may use the following syntax for everything else.
.. note::
When linking functions within a ReST file, two possible markups are:
``:cpp:`` or ``:c:``. Use ``:cpp:`` for functions defined using an
:code:c:`extern`. Use ``:c:`` for functions defined using a
:code:c:`#define`.
Function Comment Templates
**************************