summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2018-06-28 15:44:40 +0200
committerLubomir Rintel <lkundrak@v3.sk>2018-06-28 15:44:40 +0200
commit466f24db3288e4f8abb4b37837b8e22ca6d0911f (patch)
treea66883ca3d8ecfe6328d5cdfb849629e99ce394b
parent1db66f030bab5679de68ebc771f2bc23d9b27b25 (diff)
downloadNetworkManager-lr/fixes.tar.gz
docs: provide soft descriptions for NM{Simple,Remote}Connectionlr/fixes
...and order them on more logical places in the libnm manual.
-rw-r--r--docs/libnm/libnm-docs.xml2
-rw-r--r--libnm-core/nm-simple-connection.c12
-rw-r--r--libnm/nm-remote-connection.c8
3 files changed, 18 insertions, 4 deletions
diff --git a/docs/libnm/libnm-docs.xml b/docs/libnm/libnm-docs.xml
index e76f7bb0f3..14d9636e26 100644
--- a/docs/libnm/libnm-docs.xml
+++ b/docs/libnm/libnm-docs.xml
@@ -188,6 +188,7 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
<title>Connection and Setting API Reference</title>
<xi:include href="xml/nm-connection.xml"/>
<xi:include href="xml/nm-simple-connection.xml"/>
+ <xi:include href="xml/nm-remote-connection.xml"/>
<xi:include href="xml/nm-setting.xml"/>
<xi:include href="xml/nm-setting-connection.xml"/>
<!-- begin alphabetical -->
@@ -267,7 +268,6 @@ print ("NetworkManager version " + client.get_version())]]></programlisting></in
<!-- end alphabetical -->
<xi:include href="xml/nm-active-connection.xml"/>
<xi:include href="xml/nm-vpn-connection.xml"/>
- <xi:include href="xml/nm-remote-connection.xml"/>
<xi:include href="xml/nm-access-point.xml"/>
<xi:include href="xml/nm-wimax-nsp.xml"/>
<xi:include href="xml/nm-ip-config.xml"/>
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);