Commit bf769605 authored by Dan Williams's avatar Dan Williams

libnm-glib: documentation fixes

parent 0a24c811
......@@ -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)
......
......@@ -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)
......
......@@ -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)
......
......@@ -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)
......
......@@ -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
......
......@@ -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)
......
......@@ -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)
......
......@@ -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)
......
......@@ -170,7 +170,8 @@ nm_dhcp4_config_class_init (NMDHCP4ConfigClass *config_class)
*
* The #GHashTable containing options of the configuration.
*
* Type: GHashTable<utf8,GValue>
* 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)
......
......@@ -170,7 +170,8 @@ nm_dhcp6_config_class_init (NMDHCP6ConfigClass *config_class)
*
* The #GHashTable containing options of the configuration.
*
* Type: GHashTable<utf8,GValue>
* 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)
......
......@@ -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)
......
......@@ -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)
......
......@@ -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);
}
......
......@@ -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);
......
......@@ -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)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment