docs, trivial: fix some documentation issues
authorDan Williams <dcbw@redhat.com>
Wed, 20 Jan 2016 17:25:37 +0000 (11:25 -0600)
committerDan Williams <dcbw@redhat.com>
Wed, 20 Jan 2016 17:27:22 +0000 (11:27 -0600)
libnm-core/nm-setting-olpc-mesh.c
libnm-core/nm-vpn-editor-plugin.c
libnm/nm-vpn-editor.c

index 4b42c36..e61e316 100644 (file)
@@ -79,6 +79,7 @@ nm_setting_olpc_mesh_init (NMSettingOlpcMesh *setting)
 
 /**
  * nm_setting_olpc_mesh_get_ssid:
+ * @setting: the #NMSettingOlpcMesh
  *
  * Returns: (transfer none):
  */
index 2d4fdf9..e97c4be 100644 (file)
@@ -209,8 +209,11 @@ nm_vpn_editor_plugin_load_from_file  (const char *plugin_filename,
 
 /**
  * nm_vpn_editor_plugin_get_editor:
+ * @plugin: the #NMVpnEditorPlugin
+ * @connection: the #NMConnection to be edited
+ * @error: on return, an error or %NULL
  *
- * Returns: (transfer full):
+ * Returns: (transfer full): a new #NMVpnEditor or %NULL on error
  */
 NMVpnEditor *
 nm_vpn_editor_plugin_get_editor (NMVpnEditorPlugin *plugin,
@@ -232,8 +235,12 @@ nm_vpn_editor_plugin_get_capabilities (NMVpnEditorPlugin *plugin)
 
 /**
  * nm_vpn_editor_plugin_import:
+ * @plugin: the #NMVpnEditorPlugin
+ * @path: full path to the file to attempt to read into a new #NMConnection
+ * @error: on return, an error or %NULL
  *
- * Returns: (transfer full):
+ * Returns: (transfer full): a new #NMConnection imported from @path, or %NULL
+ * on error or if the file at @path was not recognized by this plugin
  */
 NMConnection *
 nm_vpn_editor_plugin_import (NMVpnEditorPlugin *plugin,
index ba6bd5e..da81d60 100644 (file)
@@ -44,6 +44,7 @@ nm_vpn_editor_default_init (NMVpnEditorInterface *iface)
 
 /**
  * nm_vpn_editor_get_widget:
+ * @editor: the #NMVpnEditor
  *
  * Returns: (transfer none):
  */