From 925d5e016b3d6e5358ef094687e287e40eb4e1c0 Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Fri, 3 Feb 2012 10:38:38 -0600 Subject: [PATCH] docs: reference NMRemoteSettings from NMClient creators It can be a bit confusing that one object doesn't do both control and configuration. So throw users a bone and tell them how. --- libnm-glib/nm-client.c | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/libnm-glib/nm-client.c b/libnm-glib/nm-client.c index fe2663ad7c..06cf3a5611 100644 --- a/libnm-glib/nm-client.c +++ b/libnm-glib/nm-client.c @@ -1115,6 +1115,10 @@ client_device_removed (NMObject *client, NMObject *device) * client. You can use nm_client_new_async() if you want to avoid * that. * + * NOTE: #NMClient provides information about devices and a mechanism to + * control them. To access and modify network configuration data, use the + * #NMRemoteSettings object. + * * Returns: a new #NMClient **/ NMClient * @@ -1166,6 +1170,10 @@ client_inited (GObject *source, GAsyncResult *result, gpointer user_data) * Creates a new #NMClient and begins asynchronously initializing it. * @callback will be called when it is done; use * nm_client_new_finish() to get the result. + * + * NOTE: #NMClient provides information about devices and a mechanism to + * control them. To access and modify network configuration data, use the + * #NMRemoteSettings object. **/ void nm_client_new_async (GCancellable *cancellable, GAsyncReadyCallback callback,