From bf76960597a01bdb4e74ccf9067964cfe00102c7 Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Thu, 10 Mar 2011 12:35:43 -0600 Subject: [PATCH] libnm-glib: documentation fixes --- libnm-glib/nm-access-point.c | 2 +- libnm-glib/nm-active-connection.c | 2 +- libnm-glib/nm-device-bt.c | 2 +- libnm-glib/nm-device-ethernet.c | 2 +- libnm-glib/nm-device-modem.h | 4 ++-- libnm-glib/nm-device-wifi.c | 2 +- libnm-glib/nm-device-wimax.c | 4 ++-- libnm-glib/nm-device.c | 2 +- libnm-glib/nm-dhcp4-config.c | 5 +++-- libnm-glib/nm-dhcp6-config.c | 5 +++-- libnm-glib/nm-ip4-config.c | 2 +- libnm-glib/nm-ip6-config.c | 2 +- libnm-glib/nm-vpn-connection.c | 15 ++++++++++++--- libnm-glib/nm-vpn-connection.h | 2 +- libnm-glib/nm-wimax-nsp.c | 4 ++-- 15 files changed, 33 insertions(+), 22 deletions(-) diff --git a/libnm-glib/nm-access-point.c b/libnm-glib/nm-access-point.c index 7672967261..7fd8f27984 100644 --- a/libnm-glib/nm-access-point.c +++ b/libnm-glib/nm-access-point.c @@ -81,7 +81,7 @@ enum { * * Creates a new #NMAccessPoint. * - * Returns: a new access point + * Returns: (transfer full): a new access point **/ GObject * nm_access_point_new (DBusGConnection *connection, const char *path) diff --git a/libnm-glib/nm-active-connection.c b/libnm-glib/nm-active-connection.c index 86936ec96a..04bf37aa0d 100644 --- a/libnm-glib/nm-active-connection.c +++ b/libnm-glib/nm-active-connection.c @@ -77,7 +77,7 @@ enum { * * Creates a new #NMActiveConnection. * - * Returns: a new active connection + * Returns: (transfer full): a new active connection **/ GObject * nm_active_connection_new (DBusGConnection *connection, const char *path) diff --git a/libnm-glib/nm-device-bt.c b/libnm-glib/nm-device-bt.c index b85d4ec087..fcad9d5b6c 100644 --- a/libnm-glib/nm-device-bt.c +++ b/libnm-glib/nm-device-bt.c @@ -62,7 +62,7 @@ enum { * * Creates a new #NMDeviceBt. * - * Returns: a new device + * Returns: (transfer full): a new device **/ GObject * nm_device_bt_new (DBusGConnection *connection, const char *path) diff --git a/libnm-glib/nm-device-ethernet.c b/libnm-glib/nm-device-ethernet.c index dfe606a478..e7a1fe2504 100644 --- a/libnm-glib/nm-device-ethernet.c +++ b/libnm-glib/nm-device-ethernet.c @@ -65,7 +65,7 @@ enum { * * Creates a new #NMDeviceEthernet. * - * Returns: a new device + * Returns: (transfer full): a new device **/ GObject * nm_device_ethernet_new (DBusGConnection *connection, const char *path) diff --git a/libnm-glib/nm-device-modem.h b/libnm-glib/nm-device-modem.h index 7a4759f2e3..bf84b90d81 100644 --- a/libnm-glib/nm-device-modem.h +++ b/libnm-glib/nm-device-modem.h @@ -56,8 +56,8 @@ typedef struct { GType nm_device_modem_get_type (void); -NMDeviceModemCapabilities nm_device_modem_get_modem_capabilities (NMDeviceModem *modem); -NMDeviceModemCapabilities nm_device_modem_get_current_capabilities (NMDeviceModem *modem); +NMDeviceModemCapabilities nm_device_modem_get_modem_capabilities (NMDeviceModem *self); +NMDeviceModemCapabilities nm_device_modem_get_current_capabilities (NMDeviceModem *self); G_END_DECLS diff --git a/libnm-glib/nm-device-wifi.c b/libnm-glib/nm-device-wifi.c index 0341983f1d..f8a891c1e7 100644 --- a/libnm-glib/nm-device-wifi.c +++ b/libnm-glib/nm-device-wifi.c @@ -91,7 +91,7 @@ static guint signals[LAST_SIGNAL] = { 0 }; * * Creates a new #NMDeviceWifi. * - * Returns: a new device + * Returns: (transfer full): a new WiFi device **/ GObject * nm_device_wifi_new (DBusGConnection *connection, const char *path) diff --git a/libnm-glib/nm-device-wimax.c b/libnm-glib/nm-device-wimax.c index aff1dafe97..6c9bd6cfd2 100644 --- a/libnm-glib/nm-device-wimax.c +++ b/libnm-glib/nm-device-wimax.c @@ -88,11 +88,11 @@ static guint signals[LAST_SIGNAL] = { 0 }; /** * nm_device_wimax_new: * @connection: the #DBusGConnection - * @path: the DBus object path of the wimax + * @path: the D-Bus object path of the WiMAX device * * Creates a new #NMDeviceWimax. * - * Returns: a new wimax + * Returns: (transfer full): a new WiMAX device **/ GObject * nm_device_wimax_new (DBusGConnection *connection, const char *path) diff --git a/libnm-glib/nm-device.c b/libnm-glib/nm-device.c index 7a36d7e1b1..bbc5416c90 100644 --- a/libnm-glib/nm-device.c +++ b/libnm-glib/nm-device.c @@ -703,7 +703,7 @@ nm_device_class_init (NMDeviceClass *device_class) * * Creates a new #NMDevice. * - * Returns: a new device + * Returns: (transfer full): a new device **/ GObject * nm_device_new (DBusGConnection *connection, const char *path) diff --git a/libnm-glib/nm-dhcp4-config.c b/libnm-glib/nm-dhcp4-config.c index 31dfe25a40..8299de0294 100644 --- a/libnm-glib/nm-dhcp4-config.c +++ b/libnm-glib/nm-dhcp4-config.c @@ -170,7 +170,8 @@ nm_dhcp4_config_class_init (NMDHCP4ConfigClass *config_class) * * The #GHashTable containing options of the configuration. * - * Type: GHashTable + * Type: GLib.HashTable + * Element-Type: utf8,GObject.Value **/ g_object_class_install_property (object_class, PROP_OPTIONS, @@ -188,7 +189,7 @@ nm_dhcp4_config_class_init (NMDHCP4ConfigClass *config_class) * * Creates a new #NMDHCP4Config. * - * Returns: a new configuration + * Returns: (transfer full): a new configuration **/ GObject * nm_dhcp4_config_new (DBusGConnection *connection, const char *object_path) diff --git a/libnm-glib/nm-dhcp6-config.c b/libnm-glib/nm-dhcp6-config.c index 7e6e4f8088..00698ed54f 100644 --- a/libnm-glib/nm-dhcp6-config.c +++ b/libnm-glib/nm-dhcp6-config.c @@ -170,7 +170,8 @@ nm_dhcp6_config_class_init (NMDHCP6ConfigClass *config_class) * * The #GHashTable containing options of the configuration. * - * Type: GHashTable + * Type: GLib.HashTable + * Element-Type: utf8,GObject.Value **/ g_object_class_install_property (object_class, PROP_OPTIONS, @@ -188,7 +189,7 @@ nm_dhcp6_config_class_init (NMDHCP6ConfigClass *config_class) * * Creates a new #NMDHCP6Config. * - * Returns: a new configuration + * Returns: (transfer full): a new configuration **/ GObject * nm_dhcp6_config_new (DBusGConnection *connection, const char *object_path) diff --git a/libnm-glib/nm-ip4-config.c b/libnm-glib/nm-ip4-config.c index 82f7e78b88..d63bc5dd4e 100644 --- a/libnm-glib/nm-ip4-config.c +++ b/libnm-glib/nm-ip4-config.c @@ -303,7 +303,7 @@ nm_ip4_config_class_init (NMIP4ConfigClass *config_class) * * Creates a new #NMIP4Config. * - * Returns: a new IP4 configuration + * Returns: (transfer full): a new IP4 configuration **/ GObject * nm_ip4_config_new (DBusGConnection *connection, const char *object_path) diff --git a/libnm-glib/nm-ip6-config.c b/libnm-glib/nm-ip6-config.c index ddaea66a6f..06b9ba60e3 100644 --- a/libnm-glib/nm-ip6-config.c +++ b/libnm-glib/nm-ip6-config.c @@ -60,7 +60,7 @@ enum { * * Creates a new #NMIP6Config. * - * Returns: a new IP6 configuration + * Returns: (transfer full): a new IP6 configuration **/ GObject * nm_ip6_config_new (DBusGConnection *connection, const char *object_path) diff --git a/libnm-glib/nm-vpn-connection.c b/libnm-glib/nm-vpn-connection.c index d0acb5d6c7..c803f120bf 100644 --- a/libnm-glib/nm-vpn-connection.c +++ b/libnm-glib/nm-vpn-connection.c @@ -60,14 +60,23 @@ enum { static guint signals[LAST_SIGNAL] = { 0 }; +/** + * nm_vpn_connection_new: + * @connection: the #DBusGConnection + * @path: the DBus object path of the new connection + * + * Creates a new #NMVPNConnection. + * + * Returns: (transfer full): a new connection object + **/ GObject * -nm_vpn_connection_new (DBusGConnection *dbus_connection, const char *path) +nm_vpn_connection_new (DBusGConnection *connection, const char *path) { - g_return_val_if_fail (dbus_connection != NULL, NULL); + g_return_val_if_fail (connection != NULL, NULL); g_return_val_if_fail (path != NULL, NULL); return g_object_new (NM_TYPE_VPN_CONNECTION, - NM_OBJECT_DBUS_CONNECTION, dbus_connection, + NM_OBJECT_DBUS_CONNECTION, connection, NM_OBJECT_DBUS_PATH, path, NULL); } diff --git a/libnm-glib/nm-vpn-connection.h b/libnm-glib/nm-vpn-connection.h index e03a80c77a..8541e704aa 100644 --- a/libnm-glib/nm-vpn-connection.h +++ b/libnm-glib/nm-vpn-connection.h @@ -65,7 +65,7 @@ typedef struct { GType nm_vpn_connection_get_type (void); -GObject * nm_vpn_connection_new (DBusGConnection *dbus_connection, const char *path); +GObject * nm_vpn_connection_new (DBusGConnection *connection, const char *path); NMVPNConnectionState nm_vpn_connection_get_vpn_state (NMVPNConnection *vpn); const char * nm_vpn_connection_get_banner (NMVPNConnection *vpn); diff --git a/libnm-glib/nm-wimax-nsp.c b/libnm-glib/nm-wimax-nsp.c index 4d2c152f89..ce24dcdafd 100644 --- a/libnm-glib/nm-wimax-nsp.c +++ b/libnm-glib/nm-wimax-nsp.c @@ -56,11 +56,11 @@ enum { /** * nm_wimax_nsp_new: * @connection: the #DBusGConnection - * @path: the DBusobject path of the wimax NSP + * @path: the D-Bus object path of the WiMAX NSP * * Creates a new #NMWimaxNsp. * - * Returns: a new wimax nsp + * Returns: (transfer full): a new WiMAX NSP **/ GObject * nm_wimax_nsp_new (DBusGConnection *connection, const char *path)