Skip to content

Commit

Permalink
Merge pull request #9 from es-ude/fix-docs
Browse files Browse the repository at this point in the history
fix docs
  • Loading branch information
glencoe committed Sep 16, 2019
2 parents 8692e6b + 9f7e9af commit c81f2a8
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 23 deletions.
8 changes: 4 additions & 4 deletions docs/Debug.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ in the ``deps`` attribute of your ``cc_*`` rule.

Then include the header where needed::
#include "Util/Debug.h"
#include "EmbeddedUtilities/Debug.h"

The header file provides the ``debug``
macro. Writing::
Expand Down Expand Up @@ -72,9 +72,9 @@ To disable the output specify ``-DDEBUG=0`` instead.
Not setting the debug flag at all will result in a warning.


Util/Debug.h
EmbeddedUtilities/Debug.h
------------

**#include "Util/Debug.h"**
**#include "EmbeddedUtilities/Debug.h"**

.. doxygenfile:: Util/Debug.h
.. doxygenfile:: EmbeddedUtilities/Debug.h
8 changes: 4 additions & 4 deletions docs/MultiReaderBuffer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
MultiReaderBuffer
-----------------

Util/MultiReaderBuffer.h
EmbeddedUtilities/MultiReaderBuffer.h
~~~~~~~~~~~~~~~~~~~~~~~~

|includeMultiReaderBuffer|_


.. |includeMultiReaderBuffer| replace:: **#include "Util/MultiReaderBuffer.h"**
.. _includeMultiReaderBuffer: https://github.com/es-ude/EmbeddedUtil/blob/master/Util/MultiReaderBuffer.h
.. |includeMultiReaderBuffer| replace:: **#include "EmbeddedUtilities/MultiReaderBuffer.h"**
.. _includeMultiReaderBuffer: https://github.com/es-ude/EmbeddedUtil/blob/master/EmbeddedUtilities/MultiReaderBuffer.h


.. doxygenfile:: Util/MultiReaderBuffer.h
.. doxygenfile:: EmbeddedUtilities/MultiReaderBuffer.h
20 changes: 10 additions & 10 deletions docs/Mutex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,38 @@ Mutex
------


Util/Mutex.h
EmbeddedUtilities/Mutex.h
~~~~~~~~~~~~

|includeMutex|_


.. |includeMutex| replace:: **#include "Util/Mutex.h"**
.. _includeMutex: https://github.com/es-ude/EmbeddedUtil/blob/master/Util/Mutex.h
.. |includeMutex| replace:: **#include "EmbeddedUtilities/Mutex.h"**
.. _includeMutex: https://github.com/es-ude/EmbeddedUtil/blob/master/EmbeddedUtilities/Mutex.h


.. doxygenfile:: Util/Mutex.h
.. doxygenfile:: EmbeddedUtilities/Mutex.h

File
++++

.. literalinclude:: ../Util/Mutex.h
.. literalinclude:: ../EmbeddedUtilities/Mutex.h
:language: c

Util/Atomic.h
EmbeddedUtilities/Atomic.h
~~~~~~~~~~~~~

|includeAtomic|_


.. |includeAtomic| replace:: **#include "Util/Atomic.h"**
.. _includeAtomic: https://github.com/es-ude/EmbeddedUtil/blob/master/Util/Atomic.h
.. |includeAtomic| replace:: **#include "EmbeddedUtilities/Atomic.h"**
.. _includeAtomic: https://github.com/es-ude/EmbeddedUtil/blob/master/EmbeddedUtilities/Atomic.h


.. doxygenfile:: Util/Atomic.h
.. doxygenfile:: EmbeddedUtilities/Atomic.h

File
++++

.. literalinclude:: ../Util/Atomic.h
.. literalinclude:: ../EmbeddedUtilities/Atomic.h
:language: c
10 changes: 5 additions & 5 deletions docs/PeriodicScheduler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@ PeriodicScheduler
-----------------


Util/PeriodicScheduler.h
EmbeddedUtilities/PeriodicScheduler.h
~~~~~~~~~~~~~~~~~~~~~~~~

|includePeriodicScheduler|_


.. |includePeriodicScheduler| replace:: **#include "Util/PeriodicScheduler.h"**
.. _includePeriodicScheduler: https://github.com/es-ude/EmbeddedUtil/blob/master/Util/PeriodicScheduler.h
.. |includePeriodicScheduler| replace:: **#include "EmbeddedUtilities/PeriodicScheduler.h"**
.. _includePeriodicScheduler: https://github.com/es-ude/EmbeddedUtil/blob/master/EmbeddedUtilities/PeriodicScheduler.h


.. doxygenfile:: Util/PeriodicScheduler.h
.. doxygenfile:: EmbeddedUtilities/PeriodicScheduler.h

File
~~~~

.. literalinclude:: ../Util/PeriodicScheduler.h
.. literalinclude:: ../EmbeddedUtilities/PeriodicScheduler.h
:language: c

0 comments on commit c81f2a8

Please sign in to comment.