settings: document nm_settings_add_connection()

1 files changed, 14 insertions, 0 deletions

diff --git a/src/settings/nm-settings.c b/src/settings/nm-settings.c
index 5e954de1dc..4a5808000e 100644
--- a/src/settings/nm-settings.c
+++ b/src/settings/nm-settings.c
@@ -879,6 +879,20 @@ remove_default_wired_connection (NMSettings *self,
 	}
 }
 
+/**
+ * nm_settings_add_connection:
+ * @self: the #NMSettings object
+ * @connection: the source connection to create a new #NMSettingsConnection from
+ * @save_to_disk: %TRUE to save the connection to disk immediately, %FALSE to
+ * not save to disk
+ * @error: on return, a location to store any errors that may occur
+ *
+ * Creates a new #NMSettingsConnection for the given source @connection.  
+ * The returned object is owned by @self and the caller must reference
+ * the object to continue using it.
+ *
+ * Returns: the new #NMSettingsConnection or %NULL
+ */
 NMSettingsConnection *
 nm_settings_add_connection (NMSettings *self,
                             NMConnection *connection,