libnm-glib: update some documentation

This commit is contained in:
Dan Williams
2011-03-10 11:55:09 -06:00
parent a7f66d0d80
commit 09b46bb269

View File

@@ -470,6 +470,7 @@ reg_request_cb (DBusGProxy *proxy,
/** /**
* nm_secret_agent_register: * nm_secret_agent_register:
* @self: a #NMSecretAgent
* *
* Registers the #NMSecretAgent with the NetworkManager secret manager, * Registers the #NMSecretAgent with the NetworkManager secret manager,
* indicating to NetworkManager that the agent is able to provide and save * indicating to NetworkManager that the agent is able to provide and save
@@ -524,6 +525,7 @@ nm_secret_agent_register (NMSecretAgent *self)
/** /**
* nm_secret_agent_unregister: * nm_secret_agent_unregister:
* @self: a #NMSecretAgent
* *
* Unregisters the #NMSecretAgent with the NetworkManager secret manager, * Unregisters the #NMSecretAgent with the NetworkManager secret manager,
* indicating to NetworkManager that the agent is will no longer provide or * indicating to NetworkManager that the agent is will no longer provide or
@@ -573,12 +575,15 @@ auto_register_cb (gpointer user_data)
* @connection: the #NMConnection for which we're asked secrets * @connection: the #NMConnection for which we're asked secrets
* @setting_name: the name of the secret setting * @setting_name: the name of the secret setting
* @hints: (array zero-terminated=1): hints to the agent * @hints: (array zero-terminated=1): hints to the agent
* @flags: * @flags: flags that modify the behavior of the request
* @callback: (scope async): a callback, invoked when the operation is done * @callback: (scope async): a callback, invoked when the operation is done
* @callback_data: (closure): * @callback_data: (closure):
* *
* Asyncronously retrieve secrets belonging to @connection for the * Asyncronously retrieve secrets belonging to @connection for the
* setting @setting_name. * setting @setting_name. @flags indicate specific behavior that the secret
* agent should use when performing the request, for example returning only
* existing secrets without user interaction, or requesting entirely new
* secrets from the user.
* *
* VFunc: get_secrets * VFunc: get_secrets
*/ */