diff options
author | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-09 11:57:41 +0200 |
---|---|---|
committer | Aleksander Morgado <aleksander@lanedo.com> | 2012-10-09 15:23:48 +0200 |
commit | 3bbdc479476a401398b1b62dac9a881bfc636feb (patch) | |
tree | 4ddf7bc0d7e92b4806eaad091fd6f5a32eb0144e /libqmi-glib | |
parent | a873852f8e0e4f248e0b7bb9acf6ab232bfcf644 (diff) |
docs: improve documentation of enums, flags and errors
Diffstat (limited to 'libqmi-glib')
-rw-r--r-- | libqmi-glib/qmi-enums-dms.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-nas.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-pds.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-wds.h | 9 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums-wms.h | 8 | ||||
-rw-r--r-- | libqmi-glib/qmi-enums.h | 7 | ||||
-rw-r--r-- | libqmi-glib/qmi-errors.h | 7 |
7 files changed, 54 insertions, 1 deletions
diff --git a/libqmi-glib/qmi-enums-dms.h b/libqmi-glib/qmi-enums-dms.h index d5d83f3..3476c4d 100644 --- a/libqmi-glib/qmi-enums-dms.h +++ b/libqmi-glib/qmi-enums-dms.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-dms + * @title: DMS enumerations and flags + * + * This section defines enumerations and flags used in the DMS service + * interface. + */ + /*****************************************************************************/ /* Helper enums for the 'QMI DMS Get Capabilities' message */ diff --git a/libqmi-glib/qmi-enums-nas.h b/libqmi-glib/qmi-enums-nas.h index 7d7055d..1d6ac10 100644 --- a/libqmi-glib/qmi-enums-nas.h +++ b/libqmi-glib/qmi-enums-nas.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-nas + * @title: NAS enumerations and flags + * + * This section defines enumerations and flags used in the NAS service + * interface. + */ + /*****************************************************************************/ /* Helper enums for the 'QMI NAS Event Report' indication */ diff --git a/libqmi-glib/qmi-enums-pds.h b/libqmi-glib/qmi-enums-pds.h index 8a64910..c6382cc 100644 --- a/libqmi-glib/qmi-enums-pds.h +++ b/libqmi-glib/qmi-enums-pds.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-pds + * @title: PDS enumerations and flags + * + * This section defines enumerations and flags used in the PDS service + * interface. + */ + /*****************************************************************************/ /* Helper enums for the 'QMI PDS Event Report' indication */ diff --git a/libqmi-glib/qmi-enums-wds.h b/libqmi-glib/qmi-enums-wds.h index 0c419aa..d8f765f 100644 --- a/libqmi-glib/qmi-enums-wds.h +++ b/libqmi-glib/qmi-enums-wds.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-wds + * @title: WDS enumerations and flags + * + * This section defines enumerations and flags used in the WDS service + * interface. + */ + #include <glib.h> /*****************************************************************************/ @@ -917,7 +925,6 @@ typedef enum { /*< underscore_name=qmi_wds_authentication >*/ QMI_WDS_AUTHENTICATION_CHAP = 1 << 1 } QmiWdsAuthentication; - /** * QmiWdsProfileType: * @QMI_WDS_PROFILE_TYPE_3GPP: 3GPP profile type. diff --git a/libqmi-glib/qmi-enums-wms.h b/libqmi-glib/qmi-enums-wms.h index 12637cf..d2df5bc 100644 --- a/libqmi-glib/qmi-enums-wms.h +++ b/libqmi-glib/qmi-enums-wms.h @@ -27,6 +27,14 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-enums-wms + * @title: WMS enumerations and flags + * + * This section defines enumerations and flags used in the WMS service + * interface. + */ + /*****************************************************************************/ /* Helper enums for the 'QMI WMS Event Report' indication */ diff --git a/libqmi-glib/qmi-enums.h b/libqmi-glib/qmi-enums.h index d16f1cc..e3cba79 100644 --- a/libqmi-glib/qmi-enums.h +++ b/libqmi-glib/qmi-enums.h @@ -28,6 +28,13 @@ #endif /** + * SECTION: qmi-enums + * @title: Common enumerations and flags + * + * This section defines common enumerations and flags used in the interface. + */ + +/** * QmiService: * @QMI_SERVICE_UNKNOWN: Unknown service. * @QMI_SERVICE_CTL: Control service. diff --git a/libqmi-glib/qmi-errors.h b/libqmi-glib/qmi-errors.h index 9dcb9ff..cafbb4c 100644 --- a/libqmi-glib/qmi-errors.h +++ b/libqmi-glib/qmi-errors.h @@ -27,6 +27,13 @@ #error "Only <libqmi-glib.h> can be included directly." #endif +/** + * SECTION: qmi-errors + * @title: Errors + * + * This section defines common error types used in the interface. + */ + /* Prefixes for errors registered in DBus */ #define QMI_DBUS_ERROR_PREFIX "org.freedesktop.libqmi.Error" #define QMI_CORE_ERROR_DBUS_PREFIX QMI_DBUS_ERROR_PREFIX ".Core" |