Improved API documentation.

sailfishos · Mar 21, 2011 · a2f0af4 · a2f0af4
1 parent 73fdebc
commit a2f0af4
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/include/idutils.h b/include/idutils.h
@@ -28,6 +28,11 @@
 
 #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)
 {
     const char SENSOR_TYPE_SEPARATOR = ';';

diff --git a/include/serviceinfo.h b/include/serviceinfo.h
@@ -29,7 +29,14 @@
 
 #include <QString>
 
+/**
+ * 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
@@ -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,