pulsensor: updated header to include namespace and generate proper html/xml with doxygen

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu 2016-01-11 16:45:57 -08:00
parent 4ff722ed2e
commit 5e37830bb7
3 changed files with 19 additions and 21 deletions

View File

@ -27,6 +27,8 @@
#include "pulsensor.h" #include "pulsensor.h"
#include <signal.h> #include <signal.h>
using namespace upm;
int doWork = 0; int doWork = 0;
void void

View File

@ -30,6 +30,8 @@
#include "pulsensor.h" #include "pulsensor.h"
using namespace upm;
#if defined(JAVACALLBACK) #if defined(JAVACALLBACK)
Pulsensor::Pulsensor (Callback *obj_call) : pin_ctx(0) Pulsensor::Pulsensor (Callback *obj_call) : pin_ctx(0)
{ {

View File

@ -40,6 +40,20 @@
#define TRUE HIGH #define TRUE HIGH
#define FALSE LOW #define FALSE LOW
/**
* Callback data struct
*/
struct clbk_data {
int is_heart_beat; /**< heartbeat check */
};
#if defined(SWIGJAVA) || defined(JAVACALLBACK)
#include "Callback.h"
#else
typedef void (* callback_handler) (clbk_data);
#endif
namespace upm {
/** /**
* @brief Pulsensor Pulse Sensor library * @brief Pulsensor Pulse Sensor library
* @defgroup pulsensor libupm-pulsensor * @defgroup pulsensor libupm-pulsensor
@ -63,26 +77,6 @@
* @image html pulsensor.jpg * @image html pulsensor.jpg
* @snippet pulsensor.cxx Interesting * @snippet pulsensor.cxx Interesting
*/ */
/*!
* @struct clbk_data
* @brief callback data
*/
struct clbk_data {
int is_heart_beat; /**< heartbeat check */
};
#if defined(SWIGJAVA) || defined(JAVACALLBACK)
#include "Callback.h"
#else
typedef void (* callback_handler) (clbk_data);
#endif
/*!
* @class Pulsensor
* @brief The context for the heartbeat pulse sensor
*/
class Pulsensor { class Pulsensor {
public: public:
@ -120,4 +114,4 @@ private:
#endif #endif
volatile uint16_t ctx_counter; volatile uint16_t ctx_counter;
}; };
}