Add Sphinx documentation

2026-08-05 01:18:36 +02:00 · 2018-11-20 17:14:59 -05:00
parent 422541fcf3
commit af45b72f9e
8 changed files with 309 additions and 6 deletions
@@ -0,0 +1,44 @@
+********************
+**C API** (icsneoc)
+********************
+
+.. Usage
+.. ======
+
+.. Finding Devices
+.. ~~~~~~~~~~~~~~~~
+.. Finding a device is simple
+
+.. Connecting to Devices
+.. ~~~~~~~~~~~~~~~~~~~~~~
+
+Reference
+==========
+
+Typedefs
+~~~~~~~~~
+.. doxygentypedef:: devicehandle_t
+.. doxygentypedef:: neodevice_handle_t
+.. doxygentypedef:: devicetype_t
+
+Structures
+~~~~~~~~~~~
+.. doxygenstruct:: neoversion_t
+   :members:
+   :undoc-members:
+
+.. doxygenstruct:: neodevice_t
+   :members:
+   :undoc-members:
+
+.. doxygenstruct:: neomessage_t
+   :members:
+   :undoc-members:
+
+.. doxygenstruct:: neomessage_can_t
+   :members:
+   :undoc-members:
+
+Functions
+~~~~~~~~~~
+.. doxygenfile:: icsneoc.h