Skip to content

W
White Rabbit Trigger Distribution
Commit d64db65c authored by Dimitris Lampridis's avatar Dimitris Lampridis
Browse files
Options

[doc] split usage in separate pages

parent 3a545fd4
Hide whitespace changes
Inline Side-by-side
Showing with 130 additions and 126 deletions
doc/index.rst
View file @ d64db65c
......@@ -15,7 +15,7 @@ White Rabbit Trigger Distribution documentation
introduction
installation
basic_concepts
usage
usage_index
ref_nodes
devel
......
doc/usage_clib.rst 0 → 100644
View file @ d64db65c
.. _clib:
C Library
=========
.. _api_error:
Error Handling API
------------------
.. _api_error_codes:
Error Codes
+++++++++++
.. doxygenenum:: wrtd_status
Functions
+++++++++
.. doxygenfunction:: wrtd_get_error
.. doxygenfunction:: wrtd_error_message
.. _api_init:
Initialisation API
------------------
.. doxygenfunction:: wrtd_init
.. doxygenfunction:: wrtd_close
.. doxygenfunction:: wrtd_reset
.. code-block:: c
#include <libwrtd.h>
int main(void) {
struct wrtd_dev *wrtd;
status = wrtd_init("MT01", false, NULL, &wrtd);
wrtd_reset(wrtd);
wrtd_close(wrtd);
}
.. _api_attr:
Attribute Handling API
----------------------
.. _api_attr_id:
Attributes
++++++++++
.. doxygenenum:: wrtd_attr
.. doxygendefine:: WRTD_GLOBAL_REP_CAP_ID
Functions
+++++++++
.. doxygenstruct:: wrtd_tstamp
:members:
.. doxygenfunction:: wrtd_set_attr_bool
.. doxygenfunction:: wrtd_get_attr_bool
.. doxygenfunction:: wrtd_set_attr_int32
.. doxygenfunction:: wrtd_get_attr_int32
.. doxygenfunction:: wrtd_set_attr_string
.. doxygenfunction:: wrtd_get_attr_string
.. doxygenfunction:: wrtd_set_attr_tstamp
.. doxygenfunction:: wrtd_get_attr_tstamp
.. _api_log:
Event Logging API
-----------------
.. doxygendefine:: WRTD_LOG_ENTRY_SIZE
.. doxygenfunction:: wrtd_clear_event_log_entries
.. doxygenfunction:: wrtd_get_next_event_log_entry
.. _api_alarm:
Alarms API
----------
.. doxygenfunction:: wrtd_add_alarm
.. doxygenfunction:: wrtd_disable_all_alarms
.. doxygenfunction:: wrtd_remove_alarm
.. doxygenfunction:: wrtd_remove_all_alarms
.. doxygenfunction:: wrtd_get_alarm_name
.. _api_rule:
Rules API
---------
.. doxygenfunction:: wrtd_add_rule
.. doxygenfunction:: wrtd_disable_all_rules
.. doxygenfunction:: wrtd_remove_rule
.. doxygenfunction:: wrtd_remove_all_rules
.. doxygenfunction:: wrtd_get_rule_name
.. doxygenfunction:: wrtd_reset_rule_stats
.. _api_app:
Applications API
----------------
.. doxygenfunction:: wrtd_get_fw_name
doc/usage_index.rst 0 → 100644
View file @ d64db65c
.. _usage:
-----
Usage
-----
.. toctree::
:maxdepth: 2
usage_clib
usage_pywrap
usage_tools
doc/usage.rst → doc/usage_pywrap.rst
View file @ d64db65c
.. _usage:
-----
Usage
-----
.. _clib:
C Library
=========
.. _api_error:
Error Handling API
------------------
.. _api_error_codes:
Error Codes
+++++++++++
.. doxygenenum:: wrtd_status
Functions
+++++++++
.. doxygenfunction:: wrtd_get_error
.. doxygenfunction:: wrtd_error_message
.. _api_init:
Initialisation API
------------------
.. doxygenfunction:: wrtd_init
.. doxygenfunction:: wrtd_close
.. doxygenfunction:: wrtd_reset
.. code-block:: c
#include <libwrtd.h>
int main(void) {
struct wrtd_dev *wrtd;
status = wrtd_init("MT01", false, NULL, &wrtd);
wrtd_reset(wrtd);
wrtd_close(wrtd);
}
.. _api_attr:
Attribute Handling API
----------------------
.. _api_attr_id:
Attributes
++++++++++
.. doxygenenum:: wrtd_attr
.. doxygendefine:: WRTD_GLOBAL_REP_CAP_ID
Functions
+++++++++
.. doxygenstruct:: wrtd_tstamp
:members:
.. doxygenfunction:: wrtd_set_attr_bool
.. doxygenfunction:: wrtd_get_attr_bool
.. doxygenfunction:: wrtd_set_attr_int32
.. doxygenfunction:: wrtd_get_attr_int32
.. doxygenfunction:: wrtd_set_attr_string
.. doxygenfunction:: wrtd_get_attr_string
.. doxygenfunction:: wrtd_set_attr_tstamp
.. doxygenfunction:: wrtd_get_attr_tstamp
.. _api_log:
Event Logging API
-----------------
.. doxygendefine:: WRTD_LOG_ENTRY_SIZE
.. doxygenfunction:: wrtd_clear_event_log_entries
.. doxygenfunction:: wrtd_get_next_event_log_entry
.. _api_alarm:
Alarms API
----------
.. doxygenfunction:: wrtd_add_alarm
.. doxygenfunction:: wrtd_disable_all_alarms
.. doxygenfunction:: wrtd_remove_alarm
.. doxygenfunction:: wrtd_remove_all_alarms
.. doxygenfunction:: wrtd_get_alarm_name
.. _api_rule:
Rules API
---------
.. doxygenfunction:: wrtd_add_rule
.. doxygenfunction:: wrtd_disable_all_rules
.. doxygenfunction:: wrtd_remove_rule
.. doxygenfunction:: wrtd_remove_all_rules
.. doxygenfunction:: wrtd_get_rule_name
.. doxygenfunction:: wrtd_reset_rule_stats
.. _api_app:
Applications API
----------------
.. doxygenfunction:: wrtd_get_fw_name
.. _pywrap:
Python Wrapper
......@@ -407,8 +287,3 @@ Applications API
... wrtd.get_fw_name(i)
'wrtd-tdc'
'wrtd-fd'
.. _tools:
Tools
=====
doc/usage_tools.rst 0 → 100644
View file @ d64db65c
.. _tools:
Tools
=====
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment