Raspberries/mraa
Private
Public Access
2
0
Fork 0
Code Activity

common.hpp: fix documentation of functions

Browse Source 
Functions inside namespace are tough to document, bypassing this by documenting
the namespace and then using the namespace doc as common.hpp doc in the index

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2014-09-01 23:17:44 +01:00
parent 9cf6cad45a
commit 21b65f5eb1
3 changed files with 16 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
api/mraa/common.hpp
View File

@@ -27,6 +27,9 @@
#include "common.h" #include "common.h"
#include <string> #include <string>
/**
* @namespace mraa namespace
*/
namespace mraa { namespace mraa {
/** /**

4
docs/index.md
View File

@@ -17,13 +17,13 @@ functionality.
<center> <center>
| C API Modules | C++ API Classes | | C API Modules | C++ API Classes |
|:----------------------:|:---------------------------:| |:----------------------:|:----------------------------:|
| @ref gpio.h "gpio" | @ref mraa::Gpio "Gpio class" | | @ref gpio.h "gpio" | @ref mraa::Gpio "Gpio class" |
| @ref i2c.h "i2c" | @ref mraa::I2c "I2c class" | | @ref i2c.h "i2c" | @ref mraa::I2c "I2c class" |
| @ref aio.h "aio" | @ref mraa::Aio "Aio class" | | @ref aio.h "aio" | @ref mraa::Aio "Aio class" |
| @ref pwm.h "pwm" | @ref mraa::Pwm "Pwm class" | | @ref pwm.h "pwm" | @ref mraa::Pwm "Pwm class" |
| @ref spi.h "spi" | @ref mraa::Spi "Spi class" | | @ref spi.h "spi" | @ref mraa::Spi "Spi class" |
| @ref common.h "common" | @ref common.hpp "common" | | @ref common.h "common" | @ref mraa "common" |
</center> </center>
### Hello Mraa ### Hello Mraa