summaryrefslogtreecommitdiff
path: root/libnm-core/nm-vpn-editor-plugin.c
diff options
context:
space:
mode:
authorDan Williams <dcbw@redhat.com>2016-01-20 11:25:37 -0600
committerDan Williams <dcbw@redhat.com>2016-01-20 11:27:22 -0600
commit3b3f108dfd77f859932385f11814b19bea65a893 (patch)
tree531a4d87a2c8bb1cb7197d122521fd6966e4c327 /libnm-core/nm-vpn-editor-plugin.c
parent0a12a1711c202c0347581d9f6cf03cbe02246dd6 (diff)
downloadNetworkManager-3b3f108dfd77f859932385f11814b19bea65a893.tar.gz
docs, trivial: fix some documentation issues
Diffstat (limited to 'libnm-core/nm-vpn-editor-plugin.c')
-rw-r--r--libnm-core/nm-vpn-editor-plugin.c11
1 files changed, 9 insertions, 2 deletions
diff --git a/libnm-core/nm-vpn-editor-plugin.c b/libnm-core/nm-vpn-editor-plugin.c
index 2d4fdf9c98..e97c4beba1 100644
--- a/libnm-core/nm-vpn-editor-plugin.c
+++ b/libnm-core/nm-vpn-editor-plugin.c
@@ -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,