colin/ModemManager
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

api,errors: document all DBus error name prefixes

Browse Source 
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.
This commit is contained in:
Aleksander Morgado
2021-05-17 22:46:15 +02:00
parent 6c56ea3b97
commit 34a50edde1
2 changed files with 61 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/reference/api/ModemManager-sections.txt
View File

@@ -59,19 +59,18 @@ MMSmsCdmaServiceCategory
<SECTION>
<FILE>mm-errors</FILE>
<TITLE>Errors</TITLE>
MMConnectionError
MMCoreError
MMMessageError
MMMobileEquipmentError
MMSerialError
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_CONNECTION_ERROR_DBUS_PREFIX
MM_SERIAL_ERROR_DBUS_PREFIX
MM_MESSAGE_ERROR_DBUS_PREFIX
MM_CDMA_ACTIVATION_ERROR_DBUS_PREFIX
MMCoreError
MMMobileEquipmentError
MMConnectionError
MMSerialError
MMMessageError
MMCdmaActivationError
</SECTION>
<SECTION>

47
include/ModemManager-errors.h
View File

@@ -31,11 +31,58 @@
* ModemManager interface.
**/
/**
* 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"
/**
* 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"
/**