diff options
| author | Aleksander Morgado <aleksander@aleksander.es> | 2021-05-17 22:46:15 +0200 |
|---|---|---|
| committer | Aleksander Morgado <aleksander@aleksander.es> | 2021-05-22 22:58:37 +0000 |
| commit | 34a50edde100436a1bbb5249b8bbb812c4fde7c2 (patch) | |
| tree | 0bf1fa2d1add4717398b88f437045f7857a82ee1 | |
| parent | 6c56ea3b97a8e4afc568316753c0c48b3aeeacb6 (diff) | |
api,errors: document all DBus error name prefixes
Since ModemManager 1.0 we were publishing symbols to identify all the
possible DBus error name prefixes, but these were never documented,
they were explicitly ignored in gtk-doc.
Let's provide proper documentation for them and make them first-class
API symbols.
| -rw-r--r-- | docs/reference/api/ModemManager-sections.txt | 17 | ||||
| -rw-r--r-- | include/ModemManager-errors.h | 57 |
2 files changed, 60 insertions, 14 deletions
diff --git a/docs/reference/api/ModemManager-sections.txt b/docs/reference/api/ModemManager-sections.txt index 214cc7fe..9b3e4f3d 100644 --- a/docs/reference/api/ModemManager-sections.txt +++ b/docs/reference/api/ModemManager-sections.txt @@ -59,19 +59,18 @@ MMSmsCdmaServiceCategory <SECTION> <FILE>mm-errors</FILE> <TITLE>Errors</TITLE> -MMConnectionError +MM_CORE_ERROR_DBUS_PREFIX +MM_MOBILE_EQUIPMENT_ERROR_DBUS_PREFIX +MM_CONNECTION_ERROR_DBUS_PREFIX +MM_SERIAL_ERROR_DBUS_PREFIX +MM_MESSAGE_ERROR_DBUS_PREFIX +MM_CDMA_ACTIVATION_ERROR_DBUS_PREFIX MMCoreError -MMMessageError MMMobileEquipmentError +MMConnectionError MMSerialError +MMMessageError MMCdmaActivationError -<SUBSECTION Private> -MM_CDMA_ACTIVATION_ERROR_DBUS_PREFIX -MM_CONNECTION_ERROR_DBUS_PREFIX -MM_CORE_ERROR_DBUS_PREFIX -MM_MESSAGE_ERROR_DBUS_PREFIX -MM_MOBILE_EQUIPMENT_ERROR_DBUS_PREFIX -MM_SERIAL_ERROR_DBUS_PREFIX </SECTION> <SECTION> diff --git a/include/ModemManager-errors.h b/include/ModemManager-errors.h index 3bcacd7b..854e83ac 100644 --- a/include/ModemManager-errors.h +++ b/include/ModemManager-errors.h @@ -31,12 +31,59 @@ * ModemManager interface. **/ -#define MM_CORE_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".Core" +/** + * MM_CORE_ERROR_DBUS_PREFIX: + * + * DBus prefix for #MMCoreError errors. + * + * Since: 1.0 + */ +#define MM_CORE_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".Core" + +/** + * MM_MOBILE_EQUIPMENT_ERROR_DBUS_PREFIX: + * + * DBus prefix for #MMMobileEquipmentError errors. + * + * Since: 1.0 + */ #define MM_MOBILE_EQUIPMENT_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".MobileEquipment" -#define MM_CONNECTION_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".Connection" -#define MM_SERIAL_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".Serial" -#define MM_MESSAGE_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".Message" -#define MM_CDMA_ACTIVATION_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".CdmaActivation" + +/** + * MM_CONNECTION_ERROR_DBUS_PREFIX: + * + * DBus prefix for #MMConnectionError errors. + * + * Since: 1.0 + */ +#define MM_CONNECTION_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".Connection" + +/** + * MM_SERIAL_ERROR_DBUS_PREFIX: + * + * DBus prefix for #MMSerialError errors. + * + * Since: 1.0 + */ +#define MM_SERIAL_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".Serial" + +/** + * MM_MESSAGE_ERROR_DBUS_PREFIX: + * + * DBus prefix for #MMMessageError errors. + * + * Since: 1.0 + */ +#define MM_MESSAGE_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".Message" + +/** + * MM_CDMA_ACTIVATION_ERROR_DBUS_PREFIX: + * + * DBus prefix for #MMCdmaActivationError errors. + * + * Since: 1.0 + */ +#define MM_CDMA_ACTIVATION_ERROR_DBUS_PREFIX MM_DBUS_ERROR_PREFIX ".CdmaActivation" /** * MMCoreError: |