zephyr/doc/doxygen
Rodrigo Caballero fb74cd4a79 Add In-Code Documentation Guidelines
The in-code Documentation Guidelines contains the best practices for
documenting code using Doxygen. The guidelines offer options for both
novice and expert developers to document their code in a compatible and
correct manner.
Fully marked and simplified templates are provided to ease the
documentation effort.
Examples taken directly from Tiny Mountain's code show the difference
clearly.
The .c files contained here are used for the examples only and do not
have any function within Tiny Mountain.
Finally, the doxygen.rst file was updated to include the new content.


Change-Id: I6a39a54feed5fa95f2f21545c3967ff0755d85ae
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:14:12 -05:00
..
doxygen.rst Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
doxygen_guidelines.rst Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
doxygen_guidelines_defines.rst Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
doxygen_guidelines_files.rst Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
doxygen_guidelines_functions.rst Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
doxygen_guidelines_structs.rst Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
doxygen_guidelines_typedefs.rst Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
doxygen_guidelines_variables.rst Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
doxygen_output.rst ADD in-code documentation integration files. 2016-02-05 20:14:00 -05:00
ex_struct_pre.c Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
hello_commented.c Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
irq_test_common_commented.h Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
phil_commented.h Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
phil_fiber_commented.c Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00
phil_task_commented.c Add In-Code Documentation Guidelines 2016-02-05 20:14:12 -05:00