doxygen: add basic doxygen documentation for upm

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
This commit is contained in:
Brendan Le Foll
2014-04-30 15:47:12 +01:00
parent b0684c98a8
commit 21991e3598
5 changed files with 2405 additions and 22 deletions

View File

@ -31,15 +31,31 @@ namespace upm {
class Hmc5883l {
public:
/// Creates a Hmc5883l object
Hmc5883l();
/// Returns the direction
float direction();
/// Returns the heading
float heading();
/**
* Returns a pointer to an int[3] that contains the coordinates as ints
* @return *int to an int[3]
*/
int* coordinates();
/**
* Updates the values by reading from i2c
*
* @return 0 for success
*/
int update();
private:
int coor[3];
char rx_tx_buf[MAX_BUFFER_LENGTH];
maa_i2c_context* i2c;
int m_coor[3];
char m_rx_tx_buf[MAX_BUFFER_LENGTH];
maa_i2c_context* m_i2c;
};
}