summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Williams <dcbw@redhat.com>2009-11-23 15:02:56 -0800
committerDan Williams <dcbw@redhat.com>2009-11-23 15:02:56 -0800
commit66994a18a33c3cb4de23b2ca28416da963a13e89 (patch)
treeb4a8b5a548137fcbf3a7a89427db4de30b66f66d
parent830bded555ac3097947be6466cb2babc2c170d02 (diff)
downloadNetworkManager-66994a18a33c3cb4de23b2ca28416da963a13e89.tar.gz
libnm-glib: trivial documentation fixes
-rw-r--r--libnm-glib/nm-access-point.c2
-rw-r--r--libnm-glib/nm-device.c5
-rw-r--r--libnm-glib/nm-remote-connection.h2
-rw-r--r--libnm-glib/nm-settings-connection-interface.c6
-rw-r--r--libnm-glib/nm-settings-system-interface.c2
5 files changed, 9 insertions, 8 deletions
diff --git a/libnm-glib/nm-access-point.c b/libnm-glib/nm-access-point.c
index fee5c98eda..777e41de6b 100644
--- a/libnm-glib/nm-access-point.c
+++ b/libnm-glib/nm-access-point.c
@@ -299,7 +299,7 @@ nm_access_point_get_max_bitrate (NMAccessPoint *ap)
/**
* nm_access_point_get_strength:
- * @ap:
+ * @ap: a #NMAccessPoint
*
* Gets the current signal strength of the access point.
*
diff --git a/libnm-glib/nm-device.c b/libnm-glib/nm-device.c
index 226b30587c..17caa99d5d 100644
--- a/libnm-glib/nm-device.c
+++ b/libnm-glib/nm-device.c
@@ -1095,13 +1095,12 @@ deactivate_cb (DBusGProxy *proxy,
/**
* nm_device_disconnect:
* @device: a #NMDevice
- * @error: a location to store an error on failure
+ * @callback: callback to be called when disconnect operation completes
+ * @user_data: caller-specific data passed to @callback
*
* Disconnects the device if currently connected, and prevents the device from
* automatically connecting to networks until the next manual network connection
* request.
- *
- * Returns: TRUE on success, FALSE if an error occurred.
**/
void
nm_device_disconnect (NMDevice *device,
diff --git a/libnm-glib/nm-remote-connection.h b/libnm-glib/nm-remote-connection.h
index 7d74eb0e6a..ef5452f99f 100644
--- a/libnm-glib/nm-remote-connection.h
+++ b/libnm-glib/nm-remote-connection.h
@@ -56,7 +56,7 @@ typedef struct {
GType nm_remote_connection_get_type (void);
-NMRemoteConnection *nm_remote_connection_new (DBusGConnection *dbus_connection,
+NMRemoteConnection *nm_remote_connection_new (DBusGConnection *bus,
NMConnectionScope scope,
const char *path);
G_END_DECLS
diff --git a/libnm-glib/nm-settings-connection-interface.c b/libnm-glib/nm-settings-connection-interface.c
index 7405fd4678..5dcd4494b4 100644
--- a/libnm-glib/nm-settings-connection-interface.c
+++ b/libnm-glib/nm-settings-connection-interface.c
@@ -24,7 +24,7 @@
/**
* nm_settings_connection_interface_update:
- * @self: an object implementing #NMSettingsConnectionInterface
+ * @connection: an object implementing #NMSettingsConnectionInterface
* @callback: a function to be called when the update completes
* @user_data: caller-specific data to be passed to @callback
*
@@ -51,7 +51,7 @@ nm_settings_connection_interface_update (NMSettingsConnectionInterface *connecti
/**
* nm_settings_connection_interface_delete:
- * @self: a objecting implementing #NMSettingsConnectionInterface
+ * @connection: a objecting implementing #NMSettingsConnectionInterface
* @callback: a function to be called when the delete completes
* @user_data: caller-specific data to be passed to @callback
*
@@ -78,7 +78,7 @@ nm_settings_connection_interface_delete (NMSettingsConnectionInterface *connecti
/**
* nm_settings_connection_interface_get_secrets:
- * @self: a object implementing #NMSettingsConnectionInterface
+ * @connection: a object implementing #NMSettingsConnectionInterface
* @setting_name: the #NMSetting object name to get secrets for
* @hints: #NMSetting key names to get secrets for (optional)
* @request_new: hint that new secrets (instead of cached or stored secrets)
diff --git a/libnm-glib/nm-settings-system-interface.c b/libnm-glib/nm-settings-system-interface.c
index 8403793b69..a2fcbf6a24 100644
--- a/libnm-glib/nm-settings-system-interface.c
+++ b/libnm-glib/nm-settings-system-interface.c
@@ -64,6 +64,8 @@ nm_settings_system_interface_save_hostname (NMSettingsSystemInterface *settings,
*
* Requests an indication of the operations the caller is permitted to perform
* including those that may require authorization.
+ *
+ * Returns: TRUE if the request was successful, FALSE if it failed
**/
gboolean
nm_settings_system_interface_get_permissions (NMSettingsSystemInterface *settings,