libnm-glib: document some properties

Some libnm-glib object properties were only documented in the GParamSpec strings, not via gtk-doc comments, so they became undocumented when the paramspec strings went away. Fix that. (Also fix incorrect gtk-doc syntax with several NMClient properties.)
2024-07-22 02:35:25 +00:00 · 2014-07-25 09:48:37 -04:00 · 2014-07-25 09:48:37 -04:00 · dafe51e881
parent 93f7fa96d6
commit dafe51e881
6 changed files with 65 additions and 10 deletions
--- a/libnm-glib/nm-client.c
+++ b/libnm-glib/nm-client.c
@ -2203,7 +2203,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::manager-running:
+	 * NMClient:manager-running:
 	 *
 	 * Whether the daemon is running.
 	 **/
@ -2215,7 +2215,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::networking-enabled:
+	 * NMClient:networking-enabled:
 	 *
 	 * Whether networking is enabled.
 	 **/
@ -2227,7 +2227,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::wireless-enabled:
+	 * NMClient:wireless-enabled:
 	 *
 	 * Whether wireless is enabled.
 	 **/
@ -2239,7 +2239,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::wireless-hardware-enabled:
+	 * NMClient:wireless-hardware-enabled:
 	 *
 	 * Whether the wireless hardware is enabled.
 	 **/
@ -2251,7 +2251,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::wwan-enabled:
+	 * NMClient:wwan-enabled:
 	 *
 	 * Whether WWAN functionality is enabled.
 	 **/
@ -2263,7 +2263,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::wwan-hardware-enabled:
+	 * NMClient:wwan-hardware-enabled:
 	 *
 	 * Whether the WWAN hardware is enabled.
 	 **/
@ -2275,7 +2275,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::wimax-enabled:
+	 * NMClient:wimax-enabled:
 	 *
 	 * Whether WiMAX functionality is enabled.
 	 **/
@ -2287,7 +2287,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::wimax-hardware-enabled:
+	 * NMClient:wimax-hardware-enabled:
 	 *
 	 * Whether the WiMAX hardware is enabled.
 	 **/
@ -2299,7 +2299,7 @@ nm_client_class_init (NMClientClass *client_class)
 		                       G_PARAM_STATIC_STRINGS));

 	/**
-	 * NMClient::active-connections:
+	 * NMClient:active-connections:
 	 *
 	 * The active connections.
 	 * Type: GPtrArray<NMActiveConnection>
--- a/libnm-glib/nm-object.c
+++ b/libnm-glib/nm-object.c
@ -391,7 +391,7 @@ nm_object_class_init (NMObjectClass *nm_object_class)
 	object_class->dispose = dispose;
 	object_class->finalize = finalize;

-	/* porperties */
+	/* Properties */

 	/**
 	 * NMObject:connection:
--- a/libnm-glib/nm-remote-connection.c
+++ b/libnm-glib/nm-remote-connection.c
@ -862,6 +862,11 @@ nm_remote_connection_class_init (NMRemoteConnectionClass *remote_class)
 	object_class->constructed = constructed;

 	/* Properties */
+	/**
+	 * NMRemoteConnection:bus:
+	 *
+	 * The #DBusGConnection that the #NMRemoteConnection is connected to.
+	 */
 	g_object_class_install_property
 		(object_class, PROP_BUS,
 		 g_param_spec_boxed (NM_REMOTE_CONNECTION_BUS, "", "",
--- a/libnm-glib/nm-remote-settings.c
+++ b/libnm-glib/nm-remote-settings.c
@ -1482,6 +1482,13 @@ nm_remote_settings_class_init (NMRemoteSettingsClass *class)
 	object_class->dispose = dispose;

 	/* Properties */
+
+	/**
+	 * NMRemoteSettings:bus:
+	 *
+	 * The #DBusGConnection that the #NMRemoteSettings is connected to. Defaults
+	 * to the system bus if not specified.
+	 */
 	g_object_class_install_property
 		(object_class, PROP_BUS,
 		 g_param_spec_boxed (NM_REMOTE_SETTINGS_BUS, "", "",
@ -1490,6 +1497,11 @@ nm_remote_settings_class_init (NMRemoteSettingsClass *class)
 		                     G_PARAM_CONSTRUCT_ONLY |
 		                     G_PARAM_STATIC_STRINGS));

+	/**
+	 * NMRemoteSettings:service-running:
+	 *
+	 * Whether the settings service is running.
+	 */
 	g_object_class_install_property
 		(object_class, PROP_SERVICE_RUNNING,
 		 g_param_spec_boolean (NM_REMOTE_SETTINGS_SERVICE_RUNNING, "", "",
@ -1497,6 +1509,12 @@ nm_remote_settings_class_init (NMRemoteSettingsClass *class)
 		                       G_PARAM_READABLE |
 		                       G_PARAM_STATIC_STRINGS));

+	/**
+	 * NMRemoteSettings:hostname:
+	 *
+	 * The machine hostname stored in persistent configuration. This can be
+	 * modified by calling nm_remote_settings_save_hostname().
+	 */
 	g_object_class_install_property
 		(object_class, PROP_HOSTNAME,
 		 g_param_spec_string (NM_REMOTE_SETTINGS_HOSTNAME, "", "",
@ -1504,6 +1522,11 @@ nm_remote_settings_class_init (NMRemoteSettingsClass *class)
 		                      G_PARAM_READABLE |
 		                      G_PARAM_STATIC_STRINGS));

+	/**
+	 * NMRemoteSettings:can-modify:
+	 *
+	 * If %TRUE, adding and modifying connections is supported.
+	 */
 	g_object_class_install_property
 		(object_class, PROP_CAN_MODIFY,
 		 g_param_spec_boolean (NM_REMOTE_SETTINGS_CAN_MODIFY, "", "",
--- a/libnm-glib/nm-vpn-plugin-ui-interface.c
+++ b/libnm-glib/nm-vpn-plugin-ui-interface.c
@ -30,18 +30,34 @@ interface_init (gpointer g_iface)
 		return;

 	/* Properties */
+
+	/**
+	 * NMVPNPluginUiInterface:name:
+	 *
+	 * Short display name of the VPN plugin.
+	 */
 	g_object_interface_install_property (g_iface,
 		 g_param_spec_string (NM_VPN_PLUGIN_UI_INTERFACE_NAME, "", "",
 		                      NULL,
 		                      G_PARAM_READABLE |
 		                      G_PARAM_STATIC_STRINGS));

+	/**
+	 * NMVPNPluginUiInterface:desc:
+	 *
+	 * Longer description of the VPN plugin.
+	 */
 	g_object_interface_install_property (g_iface,
 		 g_param_spec_string (NM_VPN_PLUGIN_UI_INTERFACE_DESC, "", "",
 		                      NULL,
 		                      G_PARAM_READABLE |
 		                      G_PARAM_STATIC_STRINGS));

+	/**
+	 * NMVPNPluginUiInterface:service:
+	 *
+	 * D-Bus service name of the plugin's VPN service.
+	 */
 	g_object_interface_install_property (g_iface,
 		 g_param_spec_string (NM_VPN_PLUGIN_UI_INTERFACE_SERVICE, "", "",
 		                      NULL,
--- a/libnm-glib/nm-vpn-plugin.c
+++ b/libnm-glib/nm-vpn-plugin.c
@ -951,6 +951,12 @@ nm_vpn_plugin_class_init (NMVPNPluginClass *plugin_class)
 	plugin_class->state_changed = state_changed;

 	/* properties */
+
+	/**
+	 * NMVPNPlugin:service-name:
+	 *
+	 * The D-Bus service name of this plugin.
+	 */
 	g_object_class_install_property
 		(object_class, PROP_DBUS_SERVICE_NAME,
 		 g_param_spec_string (NM_VPN_PLUGIN_DBUS_SERVICE_NAME, "", "",
@ -959,6 +965,11 @@ nm_vpn_plugin_class_init (NMVPNPluginClass *plugin_class)
 		                      G_PARAM_CONSTRUCT_ONLY |
 		                      G_PARAM_STATIC_STRINGS));

+	/**
+	 * NMVPNPlugin:state:
+	 *
+	 * The state of the plugin.
+	 */
 	g_object_class_install_property
 		(object_class, PROP_STATE,
 		 g_param_spec_uint (NM_VPN_PLUGIN_STATE, "", "",