libnm: add code comments to hint that NMConnection might not validate
authorThomas Haller <thaller@redhat.com>
Wed, 23 Mar 2016 16:36:28 +0000 (17:36 +0100)
committerThomas Haller <thaller@redhat.com>
Tue, 29 Mar 2016 09:56:27 +0000 (11:56 +0200)
libnm/nm-client.c
libnm/nm-device.c

index 57a43ca..a7ecdb5 100644 (file)
@@ -1189,6 +1189,9 @@ nm_client_deactivate_connection_finish (NMClient *client,
  * Returns: (transfer none) (element-type NMRemoteConnection): an array
  * containing all connections provided by the remote settings service.  The
  * returned array is owned by the #NMClient object and should not be modified.
+ *
+ * The connections are as received from D-Bus and might not validate according
+ * to nm_connection_verify().
  **/
 const GPtrArray *
 nm_client_get_connections (NMClient *client)
@@ -1207,6 +1210,9 @@ nm_client_get_connections (NMClient *client)
  *
  * Returns: (transfer none): the remote connection object on success, or %NULL if no
  *  matching object was found.
+ *
+ * The connection is as received from D-Bus and might not validate according
+ * to nm_connection_verify().
  **/
 NMRemoteConnection *
 nm_client_get_connection_by_id (NMClient *client, const char *id)
@@ -1226,6 +1232,9 @@ nm_client_get_connection_by_id (NMClient *client, const char *id)
  *
  * Returns: (transfer none): the remote connection object on success, or %NULL if the object was
  *  not known
+ *
+ * The connection is as received from D-Bus and might not validate according
+ * to nm_connection_verify().
  **/
 NMRemoteConnection *
 nm_client_get_connection_by_path (NMClient *client, const char *path)
@@ -1245,6 +1254,9 @@ nm_client_get_connection_by_path (NMClient *client, const char *path)
  *
  * Returns: (transfer none): the remote connection object on success, or %NULL if the object was
  *  not known
+ *
+ * The connection is as received from D-Bus and might not validate according
+ * to nm_connection_verify().
  **/
 NMRemoteConnection *
 nm_client_get_connection_by_uuid (NMClient *client, const char *uuid)
index 5679fd5..496dd87 100644 (file)
@@ -2329,6 +2329,9 @@ nm_device_reapply_finish (NMDevice *device,
  * Returns: (transfer full): a %NMConnection with the currently applied settings
  *   or %NULL on error.
  *
+ * The connection is as received from D-Bus and might not validate according
+ * to nm_connection_verify().
+ *
  * Since: 1.2
  **/
 NMConnection *
@@ -2457,6 +2460,9 @@ nm_device_get_applied_connection_async  (NMDevice *device,
  * Returns: (transfer full): a currently applied %NMConnection or %NULL in case
  *   of error.
  *
+ * The connection is as received from D-Bus and might not validate according
+ * to nm_connection_verify().
+ *
  * Since: 1.2
  **/
 NMConnection *