diff --git a/CMakeLists.txt b/CMakeLists.txt index 2e0c02a..deed19f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -29,7 +29,7 @@ endif() # doxygen find_package(Doxygen) if(DOXYGEN_FOUND) - set(DOXYGEN_OUT ${CMAKE_CURRENT_SOURCE_DIR}/generated/Doxyfile) + set(DOXYGEN_OUT ${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile) set(ICSNEO_DOCS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs) if(NOT EXISTS "${DOXYGEN_OUT}") set(DOXYGEN_FOUND FALSE) diff --git a/docs/Usage.rst b/docs/Usage.rst new file mode 100644 index 0000000..69877a5 --- /dev/null +++ b/docs/Usage.rst @@ -0,0 +1,44 @@ +******************** +**API Usage** (Usage) +******************** + +.. 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 diff --git a/docs/icsneocsharp.rst b/docs/icsneocsharp.rst new file mode 100644 index 0000000..8a5d7ae --- /dev/null +++ b/docs/icsneocsharp.rst @@ -0,0 +1,44 @@ +******************** +**C# API** (icsneocsharp) +******************** + +.. 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 diff --git a/docs/icsneojava.rst b/docs/icsneojava.rst new file mode 100644 index 0000000..7a10bec --- /dev/null +++ b/docs/icsneojava.rst @@ -0,0 +1,44 @@ +******************** +**Java API** (icsneojava) +******************** + +.. 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 diff --git a/docs/index.rst b/docs/index.rst index 6cf095b..fbf4d56 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,5 +5,8 @@ Welcome to libicsneo's documentation! :maxdepth: 3 :caption: Documentation + Usage + icsneojava + icsneocsharp icsneocpp icsneoc