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>
This commit is contained in:
@@ -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);
|
||||
|
||||
Reference in New Issue
Block a user