From 225f25e041ee15f9d24d9afcc898e7354e08f617 Mon Sep 17 00:00:00 2001 From: Lubomir Rintel Date: Thu, 28 Jun 2018 15:44:40 +0200 Subject: [PATCH] docs: provide soft descriptions for NM{Simple,Remote}Connection ...and order them on more logical places in the libnm manual. (cherry picked from commit e53a7365ca1fc2af9c026d0774ed7cd1af22bcf3) --- docs/libnm/libnm-docs.xml | 2 +- libnm-core/nm-simple-connection.c | 12 +++++++++--- libnm/nm-remote-connection.c | 8 ++++++++ 3 files changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/libnm/libnm-docs.xml b/docs/libnm/libnm-docs.xml index dc968f30b5..3105f514f2 100644 --- a/docs/libnm/libnm-docs.xml +++ b/docs/libnm/libnm-docs.xml @@ -187,6 +187,7 @@ print ("NetworkManager version " + client.get_version())]]>Connection and Setting API Reference + @@ -262,7 +263,6 @@ print ("NetworkManager version " + client.get_version())]]> - diff --git a/libnm-core/nm-simple-connection.c b/libnm-core/nm-simple-connection.c index f06e1aed4b..9ccdbb2197 100644 --- a/libnm-core/nm-simple-connection.c +++ b/libnm-core/nm-simple-connection.c @@ -24,6 +24,14 @@ #include "nm-simple-connection.h" #include "nm-setting-private.h" +/** + * SECTION:nm-simple-connection + * @short_description: An unmanaged connection + * + * An #NMSimpleConnection does not directly represent a D-Bus-exported connection, + * but might be used in the process of creating a new one. + **/ + static void nm_simple_connection_interface_init (NMConnectionInterface *iface); G_DEFINE_TYPE_WITH_CODE (NMSimpleConnection, nm_simple_connection, G_TYPE_OBJECT, @@ -38,9 +46,7 @@ nm_simple_connection_init (NMSimpleConnection *self) /** * nm_simple_connection_new: * - * Creates a new #NMSimpleConnection object with no #NMSetting objects. An - * #NMSimpleConnection does not directly represent a D-Bus-exported connection, - * but might be used in the process of creating a new one. + * Creates a new #NMSimpleConnection object with no #NMSetting objects. * * Returns: (transfer full): the new empty #NMConnection object **/ diff --git a/libnm/nm-remote-connection.c b/libnm/nm-remote-connection.c index 46694cd33d..6c1e092472 100644 --- a/libnm/nm-remote-connection.c +++ b/libnm/nm-remote-connection.c @@ -35,6 +35,14 @@ #include "introspection/org.freedesktop.NetworkManager.Settings.Connection.h" +/** + * SECTION:nm-remote-connection + * @short_description: A connection managed by NetworkManager server + * + * A #NMRemoteConnection represents a connection that is exported via + * NetworkManager D-Bus interface. + **/ + static void nm_remote_connection_connection_iface_init (NMConnectionInterface *iface); static void nm_remote_connection_initable_iface_init (GInitableIface *iface); static void nm_remote_connection_async_initable_iface_init (GAsyncInitableIface *iface);