common.hpp: fix documentation of functions

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>

diff --git a/DoxygenLayout.xml b/DoxygenLayout.xml
index b11e1af..814ab12 100644 (file)
--- a/DoxygenLayout.xml
+++ b/DoxygenLayout.xml
@@ -6,18 +6,18 @@
     <tab type="pages" visible="yes" title="" intro=""/>
     <tab type="modules" visible="yes" title="" intro=""/>
     <tab type="namespaces" visible="yes" title="">
-      <tab type="namespacelist" visible="yes" title="" intro=""/>
-      <tab type="namespacemembers" visible="yes" title="" intro=""/>
+    <tab type="namespacelist" visible="yes" title="" intro=""/>
+    <tab type="namespacemembers" visible="yes" title="" intro=""/>
     </tab>
     <tab type="classes" visible="yes" title="">
-      <tab type="classlist" visible="yes" title="" intro=""/>
-      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
-      <tab type="hierarchy" visible="yes" title="" intro=""/>
-      <tab type="classmembers" visible="yes" title="" intro=""/>
+    <tab type="classlist" visible="yes" title="" intro=""/>
+    <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+    <tab type="hierarchy" visible="yes" title="" intro=""/>
+    <tab type="classmembers" visible="yes" title="" intro=""/>
     </tab>
     <tab type="files" visible="yes" title="">
-      <tab type="filelist" visible="yes" title="" intro=""/>
-      <tab type="globals" visible="yes" title="" intro=""/>
+    <tab type="filelist" visible="yes" title="" intro=""/>
+    <tab type="globals" visible="yes" title="" intro=""/>
     </tab>
     <tab type="examples" visible="yes" title="" intro=""/>  
   </navindex>

diff --git a/api/mraa/common.hpp b/api/mraa/common.hpp
index 982e2c2..4745716 100644 (file)
--- a/api/mraa/common.hpp
+++ b/api/mraa/common.hpp
@@ -27,6 +27,9 @@
 #include "common.h"
 #include <string>
 
+/**
+ * @namespace mraa namespace
+ */
 namespace mraa {
 
 /**
@@ -40,7 +43,7 @@ namespace mraa {
  * Get libmraa version.
  *
  * @return libmraa version (e.g. v0.4.0-20-gb408207)
-*/
+ */
 std::string getVersion()
 {
     std::string ret = mraa_get_version();
@@ -55,7 +58,7 @@ std::string getVersion()
  *
  * @param priority Value from typically 0 to 99
  * @return The priority value set
-*/
+ */
 int setPriority(const unsigned int priority)
 {
     return mraa_set_priority(priority);

diff --git a/docs/index.md b/docs/index.md
index 826def4..4df32c8 100644 (file)
--- a/docs/index.md
+++ b/docs/index.md
@@ -16,14 +16,14 @@ classes directly wrap the C API and provide a near 1:1 mapping of
 functionality.
 
 <center>
-| C API Modules          | C++ API Classes             |
-|:----------------------:|:---------------------------:|
+| C API Modules          | C++ API Classes              |
+|:----------------------:|:----------------------------:|
 | @ref gpio.h "gpio"     | @ref mraa::Gpio "Gpio class" |
 | @ref i2c.h "i2c"       | @ref mraa::I2c "I2c class"   |
 | @ref aio.h "aio"       | @ref mraa::Aio "Aio class"   |
 | @ref pwm.h "pwm"       | @ref mraa::Pwm "Pwm 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>
 
 ### Hello Mraa