Added initial documentation files for c#, java, and usage
parent
8c186f00cd
commit
16205d29b6
|
|
@ -29,7 +29,7 @@ endif()
|
||||||
# doxygen
|
# doxygen
|
||||||
find_package(Doxygen)
|
find_package(Doxygen)
|
||||||
if(DOXYGEN_FOUND)
|
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)
|
set(ICSNEO_DOCS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs)
|
||||||
if(NOT EXISTS "${DOXYGEN_OUT}")
|
if(NOT EXISTS "${DOXYGEN_OUT}")
|
||||||
set(DOXYGEN_FOUND FALSE)
|
set(DOXYGEN_FOUND FALSE)
|
||||||
|
|
|
||||||
|
|
@ -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
|
||||||
|
|
@ -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
|
||||||
|
|
@ -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
|
||||||
|
|
@ -5,5 +5,8 @@ Welcome to libicsneo's documentation!
|
||||||
:maxdepth: 3
|
:maxdepth: 3
|
||||||
:caption: Documentation
|
:caption: Documentation
|
||||||
|
|
||||||
|
Usage
|
||||||
|
icsneojava
|
||||||
|
icsneocsharp
|
||||||
icsneocpp
|
icsneocpp
|
||||||
icsneoc
|
icsneoc
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue