diff --git a/include/idutils.h b/include/idutils.h index eb7731c5..a1deae2a 100644 --- a/include/idutils.h +++ b/include/idutils.h @@ -28,6 +28,11 @@ #include +/** + * Return leftmost part separated by ";". For example return for "foo;bar" is "foo". + * + * @param id ID to clean. + */ inline QString getCleanId(const QString& id) { const char SENSOR_TYPE_SEPARATOR = ';'; diff --git a/include/serviceinfo.h b/include/serviceinfo.h index d5d00d7e..34aa8234 100644 --- a/include/serviceinfo.h +++ b/include/serviceinfo.h @@ -29,7 +29,14 @@ #include +/** + * Name of the exported DBus service. + */ const QString SERVICE_NAME = "com.nokia.SensorService"; + +/** + * Name of the exported DBus object. + */ const QString OBJECT_PATH = "/SensorManager"; #endif // SRVC_INFO_H diff --git a/include/sfwerror.h b/include/sfwerror.h index f22584f9..3ad490aa 100644 --- a/include/sfwerror.h +++ b/include/sfwerror.h @@ -26,8 +26,14 @@ #ifndef SFW_ERROR_H #define SFW_ERROR_H +/** + * Symbol for invalid session ID. + */ static const int INVALID_SESSION = -1; +/** + * Enumeration about SensorManager error states. + */ typedef enum { SmNoError = 0, @@ -41,6 +47,9 @@ typedef enum SmAdaptorNotStarted } SensorManagerError; +/** + * Enumeration about sensor error states. + */ typedef enum { SNoError = 0,