created basic docs structure

Util/Atomic.h

@@ -4,6 +4,8 @@
 #include "Util/Callback.h"
 
 /**
+ * \file Util/Atomic.h
+ * 
  * This function has to be implemented
  * by the user of the library.
  * The function provided as parameter
@@ -22,15 +24,16 @@
  * #include <util/atomic.h>
  *
  * void
- * executeAtomically(CommunicationModule_Callback callback)
+ * executeAtomically(GenericCallback callback)
  * {
  *   ATOMIC_BLOCK(ATOMIC_STATERESTORE)
  *   {
  *     callback.function(callback.argument);
  *   }
  * }
- *
+ * ```
  */
+
 void
 executeAtomically(GenericCallback callback);
 

Util/Debug.h

@@ -4,6 +4,8 @@
 #include <stdint.h>
 
 /**
+ * \file Debug.h
+ * 
  * Implement print functions and compile with -DDEBUG=1
  * to have debug messages printed.
  */

Util/PeriodicScheduler.h

@@ -7,6 +7,7 @@
 #include "CException.h"
 
 /**
+ * \file Util/PeriodicScheduler.h
  * Overall idea here is simple.
  * Have a timer interrupt set up, like so
  *

docs/Debug.rst

@@ -19,4 +19,9 @@ The listed function declarations
 have to be implemented by the
 user.
 
-.. doxygenfile:: Debug.h
+Util/Debug.h
+------------
+
+**#include "Util/Debug.h"**
+
+.. doxygenfile:: Util/Debug.h

docs/MultiReaderBuffer.rst

@@ -0,0 +1,15 @@
+-----------------
+MultiReaderBuffer
+-----------------
+
+Util/MultiReaderBuffer.h
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+|includeMultiReaderBuffer|_ 
+
+
+.. |includeMultiReaderBuffer| replace:: **#include "Util/MultiReaderBuffer.h"**
+.. _includeMultiReaderBuffer: https://github.com/es-ude/EmbeddedUtil/blob/master/Util/MultiReaderBuffer.h
+
+
+.. doxygenfile:: Util/MultiReaderBuffer.h

docs/Mutex.rst

@@ -0,0 +1,40 @@
+------
+Mutex
+------
+
+
+Util/Mutex.h
+~~~~~~~~~~~~
+
+|includeMutex|_ 
+
+
+.. |includeMutex| replace:: **#include "Util/Mutex.h"**
+.. _includeMutex: https://github.com/es-ude/EmbeddedUtil/blob/master/Util/Mutex.h
+
+
+.. doxygenfile:: Util/Mutex.h
+
+File
+++++
+
+.. literalinclude:: ../Util/Mutex.h
+   :language: c
+
+Util/Atomic.h
+~~~~~~~~~~~~~
+
+|includeAtomic|_ 
+
+
+.. |includeAtomic| replace:: **#include "Util/Atomic.h"**
+.. _includeAtomic: https://github.com/es-ude/EmbeddedUtil/blob/master/Util/Atomic.h
+
+
+.. doxygenfile:: Util/Atomic.h
+
+File
+++++
+
+.. literalinclude:: ../Util/Atomic.h
+   :language: c

docs/PeriodicScheduler.rst

@@ -0,0 +1,22 @@
+-----------------
+PeriodicScheduler
+-----------------
+
+
+Util/PeriodicScheduler.h
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+|includePeriodicScheduler|_ 
+
+
+.. |includePeriodicScheduler| replace:: **#include "Util/PeriodicScheduler.h"**
+.. _includePeriodicScheduler: https://github.com/es-ude/EmbeddedUtil/blob/master/Util/PeriodicScheduler.h
+
+
+.. doxygenfile:: Util/PeriodicScheduler.h
+
+File
+~~~~
+
+.. literalinclude:: ../Util/PeriodicScheduler.h
+   :language: c

docs/index.rst

@@ -10,4 +10,7 @@ embedded systems.
   :maxdepth: 2
   :caption: For Users
 
+  PeriodicScheduler
   Debug
+  MultiReaderBuffer
+  Mutex