Commit Graph

3 Commits

Author SHA1 Message Date
Rodrigo Caballero a3edcaa816 doc: Edit the Event Logger APIs
Edit public API details for clarity, grammar, punctuation found
on file event_logger.h

Includes the event logger information in the ReST documentation.
Modifies doxygen.config to include the event logger.

Made consistent use of @retval to document return values.

Used imperative verbs for all @brief descriptions.

Change-Id: I88b8672a527138e2b4f7df4b4b0495a0d871cad3
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-12 01:41:20 +00:00
Rodrigo Caballero 10bea3dec8 doc: Include the I/O APIs in the documentation.
Includes the I/O drivers' interfaces in the ReST documentation.

Change-Id: I9ef70c4b0561c102b5c9425b4e41b5c813bf51b6
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-11 01:04:38 +00:00
Rodrigo Caballero c4312b652c doc: API documentation refactoring.
Restructured the API documentation and moved it from the Reference
section to the Developer guides section.

Added a note about the search function to help users find the API they
are looking for faster.

Splitted the API docs into two files one for nanokernel and another for
the microkernel APIs.

Added table of contents for each of the API sections with a back link on
the headings to take the users back to the top of the page. Making
navigation easier and more user friendly.

Change-Id: I80f415a60ea9c7df22276b464013e906e1efa511
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:25:30 -05:00