Commit a2f0af43 authored by Antti Virtanen's avatar Antti Virtanen

Improved API documentation.

parent 73fdebca
...@@ -28,6 +28,11 @@ ...@@ -28,6 +28,11 @@
#include <QString> #include <QString>
/**
* Return leftmost part separated by ";". For example return for "foo;bar" is "foo".
*
* @param id ID to clean.
*/
inline QString getCleanId(const QString& id) inline QString getCleanId(const QString& id)
{ {
const char SENSOR_TYPE_SEPARATOR = ';'; const char SENSOR_TYPE_SEPARATOR = ';';
......
...@@ -29,7 +29,14 @@ ...@@ -29,7 +29,14 @@
#include <QString> #include <QString>
/**
* Name of the exported DBus service.
*/
const QString SERVICE_NAME = "com.nokia.SensorService"; const QString SERVICE_NAME = "com.nokia.SensorService";
/**
* Name of the exported DBus object.
*/
const QString OBJECT_PATH = "/SensorManager"; const QString OBJECT_PATH = "/SensorManager";
#endif // SRVC_INFO_H #endif // SRVC_INFO_H
...@@ -26,8 +26,14 @@ ...@@ -26,8 +26,14 @@
#ifndef SFW_ERROR_H #ifndef SFW_ERROR_H
#define SFW_ERROR_H #define SFW_ERROR_H
/**
* Symbol for invalid session ID.
*/
static const int INVALID_SESSION = -1; static const int INVALID_SESSION = -1;
/**
* Enumeration about SensorManager error states.
*/
typedef enum typedef enum
{ {
SmNoError = 0, SmNoError = 0,
...@@ -41,6 +47,9 @@ typedef enum ...@@ -41,6 +47,9 @@ typedef enum
SmAdaptorNotStarted SmAdaptorNotStarted
} SensorManagerError; } SensorManagerError;
/**
* Enumeration about sensor error states.
*/
typedef enum typedef enum
{ {
SNoError = 0, SNoError = 0,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment