OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/api/event_logger.rst

31 lines
629 B
ReStructuredText
Raw Normal View History

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-08 02:00:52 +08:00
.. _event_logger:
doc: Revise kernel event logger documentation Makes the purpose and capabilities of the kernel event logger clearer, and leaves much of the low-level detail relating to use of the configuration options and APIs to the configuration option guide and API guide, respectively. Also corrects some bugs in the example code for retrieving event information. Also updates the API guide to make a clear distinction between the general purpose event logger framework and the kernel event logger (which is a specific instance of this framework). Change-Id: I924f65092b2b0e5050af13376b5da85a6cdc1a65 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-11-18 03:51:22 +08:00
Event Logging APIs
##################
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-08 02:00:52 +08:00
.. contents::
:depth: 1
:local:
:backlinks: top
Event Logger
************
doc: Revise kernel event logger documentation Makes the purpose and capabilities of the kernel event logger clearer, and leaves much of the low-level detail relating to use of the configuration options and APIs to the configuration option guide and API guide, respectively. Also corrects some bugs in the example code for retrieving event information. Also updates the API guide to make a clear distinction between the general purpose event logger framework and the kernel event logger (which is a specific instance of this framework). Change-Id: I924f65092b2b0e5050af13376b5da85a6cdc1a65 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-11-18 03:51:22 +08:00
An event logger is an object that can record the occurrence of significant
events, which can be subsequently extracted and reviewed.
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-08 02:00:52 +08:00
.. doxygengroup:: event_logger
:project: Zephyr
doc: Revise kernel event logger documentation Makes the purpose and capabilities of the kernel event logger clearer, and leaves much of the low-level detail relating to use of the configuration options and APIs to the configuration option guide and API guide, respectively. Also corrects some bugs in the example code for retrieving event information. Also updates the API guide to make a clear distinction between the general purpose event logger framework and the kernel event logger (which is a specific instance of this framework). Change-Id: I924f65092b2b0e5050af13376b5da85a6cdc1a65 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-11-18 03:51:22 +08:00
:content-only:
Kernel Event Logger
*******************
The kernel event logger records the occurrence of significant kernel events,
which can be subsequently extracted and reviewed.
(See :ref:`kernel_event_logger_v2`.)
.. doxygengroup:: kernel_event_logger
:project: Zephyr
:content-only: