diff options
author | Aleksander Morgado <aleksander@aleksander.es> | 2017-02-10 13:39:31 +0100 |
---|---|---|
committer | Aleksander Morgado <aleksander@aleksander.es> | 2017-02-10 18:57:06 +0100 |
commit | 3718c2ceabef4bd03bc3b7989e407763b85dcdd3 (patch) | |
tree | 4a55d6ccf64846f12ea07d0e5d0f7a2dee3538b8 | |
parent | 88d359df18e1b40d9faa06aa28596b1cb5cd8c8e (diff) | |
download | external_libqmi-3718c2ceabef4bd03bc3b7989e407763b85dcdd3.zip external_libqmi-3718c2ceabef4bd03bc3b7989e407763b85dcdd3.tar.gz external_libqmi-3718c2ceabef4bd03bc3b7989e407763b85dcdd3.tar.bz2 |
docs: update compat symbols documentation
-rw-r--r-- | src/libqmi-glib/qmi-compat.c | 48 | ||||
-rw-r--r-- | src/libqmi-glib/qmi-compat.h | 62 |
2 files changed, 62 insertions, 48 deletions
diff --git a/src/libqmi-glib/qmi-compat.c b/src/libqmi-glib/qmi-compat.c index 0e76e96..c00bc91 100644 --- a/src/libqmi-glib/qmi-compat.c +++ b/src/libqmi-glib/qmi-compat.c @@ -21,18 +21,6 @@ #include "qmi-compat.h" -/** - * qmi_message_dms_set_service_programming_code_input_get_new: - * @self: a #QmiMessageDmsSetServiceProgrammingCodeInput. - * @arg_new: a placeholder for the output constant string, or %NULL if not required. - * @error: Return location for error or %NULL. - * - * Get the 'New Code' field from @self. - * - * Returns: %TRUE if the field is found, %FALSE otherwise. - * - * Deprecated: 1.14.0: Use qmi_message_dms_set_service_programming_code_input_get_new_code() instead. - */ gboolean qmi_message_dms_set_service_programming_code_input_get_new ( QmiMessageDmsSetServiceProgrammingCodeInput *self, @@ -42,18 +30,6 @@ qmi_message_dms_set_service_programming_code_input_get_new ( return qmi_message_dms_set_service_programming_code_input_get_new_code (self, arg_new, error); } -/** - * qmi_message_dms_set_service_programming_code_input_set_new: - * @self: a #QmiMessageDmsSetServiceProgrammingCodeInput. - * @arg_new: a constant string of exactly 6 characters. - * @error: Return location for error or %NULL. - * - * Set the 'New Code' field in the message. - * - * Returns: %TRUE if @value was successfully set, %FALSE otherwise. - * - * Deprecated: 1.14.0: Use qmi_message_dms_set_service_programming_code_input_set_new_code() instead. - */ gboolean qmi_message_dms_set_service_programming_code_input_set_new ( QmiMessageDmsSetServiceProgrammingCodeInput *self, @@ -63,18 +39,6 @@ qmi_message_dms_set_service_programming_code_input_set_new ( return qmi_message_dms_set_service_programming_code_input_set_new_code (self, arg_new, error); } -/** - * qmi_message_dms_set_service_programming_code_input_get_current: - * @self: a #QmiMessageDmsSetServiceProgrammingCodeInput. - * @arg_current: a placeholder for the output constant string, or %NULL if not required. - * @error: Return location for error or %NULL. - * - * Get the 'Current Code' field from @self. - * - * Returns: %TRUE if the field is found, %FALSE otherwise. - * - * Deprecated: 1.14.0: Use qmi_message_dms_set_service_programming_code_input_get_current_code() instead. - */ gboolean qmi_message_dms_set_service_programming_code_input_get_current ( QmiMessageDmsSetServiceProgrammingCodeInput *self, @@ -84,18 +48,6 @@ qmi_message_dms_set_service_programming_code_input_get_current ( return qmi_message_dms_set_service_programming_code_input_get_current_code (self, arg_current, error); } -/** - * qmi_message_dms_set_service_programming_code_input_set_current: - * @self: a #QmiMessageDmsSetServiceProgrammingCodeInput. - * @arg_current: a placeholder for the output constant string, or %NULL if not required. - * @error: Return location for error or %NULL. - * - * Get the 'Current Code' field from @self. - * - * Returns: %TRUE if the field is found, %FALSE otherwise. - * - * Deprecated: 1.14.0: Use qmi_message_dms_set_service_programming_code_input_set_current_code() instead. - */ gboolean qmi_message_dms_set_service_programming_code_input_set_current ( QmiMessageDmsSetServiceProgrammingCodeInput *self, diff --git a/src/libqmi-glib/qmi-compat.h b/src/libqmi-glib/qmi-compat.h index 2ddfae1..1a677ce 100644 --- a/src/libqmi-glib/qmi-compat.h +++ b/src/libqmi-glib/qmi-compat.h @@ -32,24 +32,85 @@ /* These are compatibility methods and symbols to cover some API breaks * introduced in 1.14.0 */ +/** + * SECTION:qmi-compat + * @title: API break replacements + * + * These compatibility types and methods are flagged as deprecated and therefore + * shouldn't be used in newly written code. They are provided to avoid + * innecessary API/ABI breaks. + */ + +/** + * qmi_message_dms_set_service_programming_code_input_get_new: + * @self: a #QmiMessageDmsSetServiceProgrammingCodeInput. + * @arg_new: a placeholder for the output constant string, or %NULL if not required. + * @error: Return location for error or %NULL. + * + * Get the 'New Code' field from @self. + * + * Returns: %TRUE if the field is found, %FALSE otherwise. + * + * Since: 1.0 + * Deprecated: 1.14.0: Use qmi_message_dms_set_service_programming_code_input_get_new_code() instead. + */ G_DEPRECATED_FOR (qmi_message_dms_set_service_programming_code_input_get_new_code) gboolean qmi_message_dms_set_service_programming_code_input_get_new ( QmiMessageDmsSetServiceProgrammingCodeInput *self, const gchar **arg_new, GError **error); +/** + * qmi_message_dms_set_service_programming_code_input_set_new: + * @self: a #QmiMessageDmsSetServiceProgrammingCodeInput. + * @arg_new: a constant string of exactly 6 characters. + * @error: Return location for error or %NULL. + * + * Set the 'New Code' field in the message. + * + * Returns: %TRUE if @value was successfully set, %FALSE otherwise. + * + * Since: 1.0 + * Deprecated: 1.14.0: Use qmi_message_dms_set_service_programming_code_input_set_new_code() instead. + */ G_DEPRECATED_FOR (qmi_message_dms_set_service_programming_code_input_set_new_code) gboolean qmi_message_dms_set_service_programming_code_input_set_new ( QmiMessageDmsSetServiceProgrammingCodeInput *self, const gchar *arg_new, GError **error); +/** + * qmi_message_dms_set_service_programming_code_input_get_current: + * @self: a #QmiMessageDmsSetServiceProgrammingCodeInput. + * @arg_current: a placeholder for the output constant string, or %NULL if not required. + * @error: Return location for error or %NULL. + * + * Get the 'Current Code' field from @self. + * + * Returns: %TRUE if the field is found, %FALSE otherwise. + * + * Since: 1.0 + * Deprecated: 1.14.0: Use qmi_message_dms_set_service_programming_code_input_get_current_code() instead. + */ G_DEPRECATED_FOR (qmi_message_dms_set_service_programming_code_input_get_current_code) gboolean qmi_message_dms_set_service_programming_code_input_get_current ( QmiMessageDmsSetServiceProgrammingCodeInput *self, const gchar **arg_current, GError **error); +/** + * qmi_message_dms_set_service_programming_code_input_set_current: + * @self: a #QmiMessageDmsSetServiceProgrammingCodeInput. + * @arg_current: a placeholder for the output constant string, or %NULL if not required. + * @error: Return location for error or %NULL. + * + * Get the 'Current Code' field from @self. + * + * Returns: %TRUE if the field is found, %FALSE otherwise. + * + * Since: 1.0 + * Deprecated: 1.14.0: Use qmi_message_dms_set_service_programming_code_input_set_current_code() instead. + */ G_DEPRECATED_FOR (qmi_message_dms_set_service_programming_code_input_set_current_code) gboolean qmi_message_dms_set_service_programming_code_input_set_current ( QmiMessageDmsSetServiceProgrammingCodeInput *self, @@ -61,6 +122,7 @@ gboolean qmi_message_dms_set_service_programming_code_input_set_current ( * * SIM available. * + * Since: 1.0 * Deprecated: 1.14.0: Use the correct #QMI_NAS_SIM_REJECT_STATE_SIM_AVAILABLE name instead. */ G_DEPRECATED_FOR (QMI_NAS_SIM_REJECT_STATE_SIM_AVAILABLE) |