zephyr/doc/reference/api.rst

.. _api:

Auto-generated API Documentation
################################

.. doxygenindex::
   :project: Zephyr
Doc: Create the Reference Guides part. Placeholders were created for the missing content. The automatically generated API docs were separated from the Doxygen collaboration guide. The Kbuild User's Guide was moved unchanged. Change-Id: I07dfed61bfbb3cad60372c57dc3cbdf627c872f0 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> 2015-08-08 06:24:03 +08:00			`.. _api:`
ADD in-code documentation integration files. Includes an explanation of how the in-code documentation is integrated using Doxygen / Breathe and the raw generated output from the code. These files are needed to understand how the in-code comments flow into the documentation and to be able to display and link to those comments from the documentation. Change-Id: I275f8c32cfe889da43b4db5b8037e52876ae3c68 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2015-05-16 00:39:18 +08:00
DOC: Restructures the documentation in two parts. The contents are split in two: Zephyr Kernel and Zephyr Project. Under Zephyr Kernel is all the content directly about the code base. Under Zephyr Project is all the content about the development of the kernel and of applications. Only the Doxygen document needed to be split. The output of the in-code comments was placed under the Zephyr Kernel while all the Doxygen guidelines and the extraction process information were placed under the Zephyr Project. Change-Id: I4f7b674d19449968e976b63f40bcaa9737cc0ecb Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> 2015-07-21 04:26:16 +08:00			`Auto-generated API Documentation`
			`################################`
ADD in-code documentation integration files. Includes an explanation of how the in-code documentation is integrated using Doxygen / Breathe and the raw generated output from the code. These files are needed to understand how the in-code comments flow into the documentation and to be able to display and link to those comments from the documentation. Change-Id: I275f8c32cfe889da43b4db5b8037e52876ae3c68 Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2015-05-16 00:39:18 +08:00
			`.. doxygenindex::`
Tiny Mountain -> Zephyr renames Change-Id: I323c3c2bc06c8fc2b6200186dde6853c61b094a8 Signed-off-by: Anas Nashif <anas.nashif@intel.com> 2015-06-14 04:08:26 +08:00			`:project: Zephyr`