API: Add icsneoc2

docs/conf.py

@@ -7,6 +7,7 @@ import subprocess
 
 subprocess.call('cd ..; doxygen docs/icsneocpp/Doxyfile', shell=True)
 subprocess.call('cd ..; doxygen docs/icsneoc/Doxyfile', shell=True)
+subprocess.call('cd ..; doxygen docs/icsneoc2/Doxyfile', shell=True)
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -26,6 +27,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 breathe_projects = {
     'icsneocpp': 'icsneocpp/doxygen/xml',
     'icsneoc': 'icsneoc/doxygen/xml',
+    'icsneoc2': 'icsneoc2/doxygen/xml',
 }
 
 breathe_default_project = 'icsneocpp'

docs/icsneoc/.gitignore

@@ -0,0 +1 @@
+doxygen

docs/icsneoc/index.rst

@@ -1,5 +1,5 @@
-icsneoc
-=======
+icsneoc (deprecated, use icsneoc2)
+============================
 
 .. toctree::
    :maxdepth: 2

docs/icsneoc2/.gitignore

@@ -0,0 +1 @@
+doxygen

docs/icsneoc2/api.rst

@@ -0,0 +1,12 @@
+======
+C2 API
+======
+
+.. doxygenfile:: icsneoc2.h
+   :project: icsneoc2
+.. doxygenfile:: icsneoc2messages.h
+   :project: icsneoc2
+.. doxygenfile:: icsneoc2settings.h
+   :project: icsneoc2
+.. doxygenfile:: icsneoc2types.h
+   :project: icsneoc2

docs/icsneoc2/examples.rst

@@ -0,0 +1,27 @@
+=================
+icsneoc2 Examples
+=================
+
+Simple
+======
+
+:download:`Download example <../../examples/c2/simple/src/main.c>`
+
+.. literalinclude:: ../../examples/c2/simple/src/main.c
+   :language: c
+
+Disk Format
+===========
+
+:download:`Download example <../../examples/c2/diskformat/src/main.c>`
+
+.. literalinclude:: ../../examples/c2/diskformat/src/main.c
+   :language: c
+
+Read Messages
+=============
+
+:download:`Download example <../../examples/c2/read_messages/src/main.c>`
+
+.. literalinclude:: ../../examples/c2/read_messages/src/main.c
+   :language: c

docs/icsneoc2/index.rst

@@ -0,0 +1,9 @@
+icsneoc2
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   installation
+   examples
+   api

docs/icsneoc2/installation.rst

@@ -0,0 +1,7 @@
+============
+Installation
+============
+
+The installation steps for the C2 API are the same as the C++ API as the C2 API is
+a wrapper for the C++ library. The ``LIBICSNEO_BUILD_ICSNEOC2`` CMake option is
+default ``ON`` but note that the C2 API depends on this flag to build.

docs/icsneocpp/.gitignore

@@ -0,0 +1 @@
+doxygen

docs/index.rst

@@ -13,3 +13,4 @@ communication library. The source code for libicsneo can be found on GitHub:
    icsneocpp/index
    icsneopy/index
    icsneoc/index
+   icsneoc2/index