libnm: add gtk-doc Since markers for new API and missing enum documentation

This commit is contained in:
Thomas Haller 2017-08-17 23:08:44 +02:00
parent 0480dae749
commit 72baa8e30b
3 changed files with 22 additions and 0 deletions

View file

@ -484,6 +484,8 @@ nm_client_wimax_hardware_get_enabled (NMClient *client)
* configuration file.
*
* Returns: %TRUE if connectivity checking is available.
*
* Since: 1.10
*/
gboolean
nm_client_connectivity_check_get_available (NMClient *client)
@ -503,6 +505,8 @@ nm_client_connectivity_check_get_available (NMClient *client)
* Determine whether connectivity checking is enabled.
*
* Returns: %TRUE if connectivity checking is enabled.
*
* Since: 1.10
*/
gboolean
nm_client_connectivity_check_get_enabled (NMClient *client)
@ -523,6 +527,8 @@ nm_client_connectivity_check_get_enabled (NMClient *client)
* Enable or disable connectivity checking. Note that if a
* connectivity checking URI has not been configured, this will not
* have any effect.
*
* Since: 1.10
*/
void
nm_client_connectivity_check_set_enabled (NMClient *client, gboolean enabled)
@ -2970,6 +2976,8 @@ nm_client_class_init (NMClientClass *client_class)
* NMClient::connectivity-check-available
*
* Whether a connectivity checking service has been configured.
*
* Since: 1.10
*/
g_object_class_install_property
(object_class, PROP_CONNECTIVITY_CHECK_AVAILABLE,
@ -2982,6 +2990,8 @@ nm_client_class_init (NMClientClass *client_class)
* NMClient::connectivity-check-enabled
*
* Whether a connectivity checking service has been enabled.
*
* Since: 1.10
*/
g_object_class_install_property
(object_class, PROP_CONNECTIVITY_CHECK_ENABLED,

View file

@ -105,6 +105,8 @@ G_BEGIN_DECLS
* @NM_CLIENT_PERMISSION_CHECKPOINT_ROLLBACK: permission to create checkpoints.
* @NM_CLIENT_PERMISSION_ENABLE_DISABLE_STATISTICS: controls whether device
* statistics can be globally enabled or disabled
* @NM_CLIENT_PERMISSION_ENABLE_DISABLE_CONNECTIVITY_CHECK: controls whether
* connectivity check can be enabled or disabled
* @NM_CLIENT_PERMISSION_LAST: a reserved boundary value
*
* #NMClientPermission values indicate various permissions that NetworkManager
@ -252,8 +254,13 @@ gboolean nm_client_wimax_get_enabled (NMClient *client);
void nm_client_wimax_set_enabled (NMClient *client, gboolean enabled);
gboolean nm_client_wimax_hardware_get_enabled (NMClient *client);
NM_AVAILABLE_IN_1_10
gboolean nm_client_connectivity_check_get_available (NMClient *client);
NM_AVAILABLE_IN_1_10
gboolean nm_client_connectivity_check_get_enabled (NMClient *client);
NM_AVAILABLE_IN_1_10
void nm_client_connectivity_check_set_enabled (NMClient *client,
gboolean enabled);

View file

@ -99,8 +99,13 @@ gboolean nm_manager_wimax_get_enabled (NMManager *manager);
void nm_manager_wimax_set_enabled (NMManager *manager, gboolean enabled);
gboolean nm_manager_wimax_hardware_get_enabled (NMManager *manager);
NM_AVAILABLE_IN_1_10
gboolean nm_manager_connectivity_check_get_available (NMManager *manager);
NM_AVAILABLE_IN_1_10
gboolean nm_manager_connectivity_check_get_enabled (NMManager *manager);
NM_AVAILABLE_IN_1_10
void nm_manager_connectivity_check_set_enabled (NMManager *manager,
gboolean enabled);