From 7bd69aa08d99583c9824ab4145fcba1ff089b497 Mon Sep 17 00:00:00 2001
From: Lubomir Rintel <lkundrak@v3.sk>
Date: Fri, 10 Mar 2017 20:04:34 +0100
Subject: [PATCH] libnm-core: sensible docstrings for NMSettings*

---
 libnm-core/nm-setting-8021x.h             | 2 ++
 libnm-core/nm-setting-adsl.h              | 2 ++
 libnm-core/nm-setting-bluetooth.h         | 2 ++
 libnm-core/nm-setting-bond.h              | 2 ++
 libnm-core/nm-setting-bridge-port.h       | 2 ++
 libnm-core/nm-setting-bridge.h            | 2 ++
 libnm-core/nm-setting-cdma.h              | 2 ++
 libnm-core/nm-setting-connection.h        | 3 +--
 libnm-core/nm-setting-dcb.h               | 2 ++
 libnm-core/nm-setting-dummy.h             | 2 ++
 libnm-core/nm-setting-generic.h           | 2 ++
 libnm-core/nm-setting-gsm.h               | 2 ++
 libnm-core/nm-setting-infiniband.h        | 2 ++
 libnm-core/nm-setting-ip-tunnel.h         | 2 ++
 libnm-core/nm-setting-ip4-config.h        | 2 ++
 libnm-core/nm-setting-ip6-config.h        | 2 ++
 libnm-core/nm-setting-macsec.h            | 2 ++
 libnm-core/nm-setting-macvlan.h           | 2 ++
 libnm-core/nm-setting-olpc-mesh.h         | 2 ++
 libnm-core/nm-setting-ppp.h               | 2 ++
 libnm-core/nm-setting-pppoe.h             | 2 ++
 libnm-core/nm-setting-proxy.h             | 5 +++++
 libnm-core/nm-setting-serial.h            | 2 ++
 libnm-core/nm-setting-team-port.h         | 2 ++
 libnm-core/nm-setting-team.h              | 2 ++
 libnm-core/nm-setting-tun.h               | 2 ++
 libnm-core/nm-setting-vlan.h              | 2 ++
 libnm-core/nm-setting-vpn.h               | 2 ++
 libnm-core/nm-setting-vxlan.h             | 2 ++
 libnm-core/nm-setting-wimax.h             | 2 ++
 libnm-core/nm-setting-wired.h             | 2 ++
 libnm-core/nm-setting-wireless-security.h | 2 ++
 libnm-core/nm-setting-wireless.h          | 2 ++
 33 files changed, 68 insertions(+), 2 deletions(-)

diff --git a/libnm-core/nm-setting-8021x.h b/libnm-core/nm-setting-8021x.h
index 073d6e8851..0f5f7ddd9e 100644
--- a/libnm-core/nm-setting-8021x.h
+++ b/libnm-core/nm-setting-8021x.h
@@ -174,6 +174,8 @@ typedef enum { /*< underscore_name=nm_setting_802_1x_auth_flags >*/
 
 /**
  * NMSetting8021x:
+ *
+ * AIEEE 802.1x Authentication Settings
  */
 struct _NMSetting8021x {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-adsl.h b/libnm-core/nm-setting-adsl.h
index d1f975e962..4f04355ec8 100644
--- a/libnm-core/nm-setting-adsl.h
+++ b/libnm-core/nm-setting-adsl.h
@@ -56,6 +56,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingAdsl:
+ *
+ * ADSL Settings
  */
 struct _NMSettingAdsl {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-bluetooth.h b/libnm-core/nm-setting-bluetooth.h
index 6746782e7c..312aab1440 100644
--- a/libnm-core/nm-setting-bluetooth.h
+++ b/libnm-core/nm-setting-bluetooth.h
@@ -61,6 +61,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingBluetooth:
+ *
+ * Bluetooth Settings
  */
 struct _NMSettingBluetooth {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-bond.h b/libnm-core/nm-setting-bond.h
index ee2da97778..e2d8f9b562 100644
--- a/libnm-core/nm-setting-bond.h
+++ b/libnm-core/nm-setting-bond.h
@@ -72,6 +72,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingBond:
+ *
+ * Bonding Settings
  */
 struct _NMSettingBond {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-bridge-port.h b/libnm-core/nm-setting-bridge-port.h
index 690f9d0df9..0ff6d9f13b 100644
--- a/libnm-core/nm-setting-bridge-port.h
+++ b/libnm-core/nm-setting-bridge-port.h
@@ -45,6 +45,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingBridgePort:
+ *
+ * Bridge Port Settings
  */
 struct _NMSettingBridgePort {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-bridge.h b/libnm-core/nm-setting-bridge.h
index 918b9c16c8..81e4c64424 100644
--- a/libnm-core/nm-setting-bridge.h
+++ b/libnm-core/nm-setting-bridge.h
@@ -50,6 +50,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingBridge:
+ *
+ * Bridging Settings
  */
 struct _NMSettingBridge {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-cdma.h b/libnm-core/nm-setting-cdma.h
index 85ad3e4c86..6e429bd122 100644
--- a/libnm-core/nm-setting-cdma.h
+++ b/libnm-core/nm-setting-cdma.h
@@ -48,6 +48,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingCdma:
+ *
+ * CDMA-based Mobile Broadband Settings
  */
 struct _NMSettingCdma {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-connection.h b/libnm-core/nm-setting-connection.h
index 89fa64ce6d..bd5b98ff4a 100644
--- a/libnm-core/nm-setting-connection.h
+++ b/libnm-core/nm-setting-connection.h
@@ -99,8 +99,7 @@ typedef enum {
 /**
  * NMSettingConnection:
  *
- * The NMSettingConnection struct contains only private data.
- * It should only be accessed through the functions described below.
+ * General Connection Profile Settings
  */
 struct _NMSettingConnection {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-dcb.h b/libnm-core/nm-setting-dcb.h
index 4a3c7329d1..d2a364a224 100644
--- a/libnm-core/nm-setting-dcb.h
+++ b/libnm-core/nm-setting-dcb.h
@@ -94,6 +94,8 @@ typedef enum { /*< flags >*/
 
 /**
  * NMSettingDcb:
+ *
+ * Data Center Bridging Settings
  */
 struct _NMSettingDcb {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-dummy.h b/libnm-core/nm-setting-dummy.h
index fdeb76059f..62fe3fa67a 100644
--- a/libnm-core/nm-setting-dummy.h
+++ b/libnm-core/nm-setting-dummy.h
@@ -41,6 +41,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingDummy:
+ *
+ * Dummy Link Settings
  */
 struct _NMSettingDummy {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-generic.h b/libnm-core/nm-setting-generic.h
index a5e94f6251..864b900494 100644
--- a/libnm-core/nm-setting-generic.h
+++ b/libnm-core/nm-setting-generic.h
@@ -41,6 +41,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingGeneric:
+ *
+ * Generic Link Settings
  */
 struct _NMSettingGeneric {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-gsm.h b/libnm-core/nm-setting-gsm.h
index 8dd4793efa..8516698dbd 100644
--- a/libnm-core/nm-setting-gsm.h
+++ b/libnm-core/nm-setting-gsm.h
@@ -56,6 +56,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingGsm:
+ *
+ * GSM-based Mobile Broadband Settings
  */
 struct _NMSettingGsm {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-infiniband.h b/libnm-core/nm-setting-infiniband.h
index 30e1158fe1..ff78b3dce5 100644
--- a/libnm-core/nm-setting-infiniband.h
+++ b/libnm-core/nm-setting-infiniband.h
@@ -47,6 +47,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingInfiniband:
+ *
+ * Infiniband Settings
  */
 struct _NMSettingInfiniband {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-ip-tunnel.h b/libnm-core/nm-setting-ip-tunnel.h
index 081b171b04..dfa6211685 100644
--- a/libnm-core/nm-setting-ip-tunnel.h
+++ b/libnm-core/nm-setting-ip-tunnel.h
@@ -53,6 +53,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingIPTunnel:
+ *
+ * IP Tunneling Settings
  */
 struct _NMSettingIPTunnel {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-ip4-config.h b/libnm-core/nm-setting-ip4-config.h
index adef375464..ca89450937 100644
--- a/libnm-core/nm-setting-ip4-config.h
+++ b/libnm-core/nm-setting-ip4-config.h
@@ -89,6 +89,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingIP4Config:
+ *
+ * IPv4 Settings
  */
 struct _NMSettingIP4Config {
 	NMSettingIPConfig parent;
diff --git a/libnm-core/nm-setting-ip6-config.h b/libnm-core/nm-setting-ip6-config.h
index 8e2c7771d1..e01a36b756 100644
--- a/libnm-core/nm-setting-ip6-config.h
+++ b/libnm-core/nm-setting-ip6-config.h
@@ -139,6 +139,8 @@ typedef enum {
 
 /**
  * NMSettingIP6Config:
+ *
+ * IPv6 Settings
  */
 struct _NMSettingIP6Config {
 	NMSettingIPConfig parent;
diff --git a/libnm-core/nm-setting-macsec.h b/libnm-core/nm-setting-macsec.h
index f9431dfe51..6a524faabf 100644
--- a/libnm-core/nm-setting-macsec.h
+++ b/libnm-core/nm-setting-macsec.h
@@ -50,6 +50,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingMacsec:
+ *
+ * MACSec Settings
  */
 struct _NMSettingMacsec {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-macvlan.h b/libnm-core/nm-setting-macvlan.h
index 33860aacc2..605efd0f9e 100644
--- a/libnm-core/nm-setting-macvlan.h
+++ b/libnm-core/nm-setting-macvlan.h
@@ -46,6 +46,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingMacvlan:
+ *
+ * MAC VLAN Settings
  */
 struct _NMSettingMacvlan {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-olpc-mesh.h b/libnm-core/nm-setting-olpc-mesh.h
index 162373b3e4..69b3c6e96e 100644
--- a/libnm-core/nm-setting-olpc-mesh.h
+++ b/libnm-core/nm-setting-olpc-mesh.h
@@ -46,6 +46,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingOlpcMesh:
+ *
+ * OLPC Wireless Mesh Settings
  */
 struct _NMSettingOlpcMesh {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-ppp.h b/libnm-core/nm-setting-ppp.h
index 39b578b35e..01536d84c7 100644
--- a/libnm-core/nm-setting-ppp.h
+++ b/libnm-core/nm-setting-ppp.h
@@ -61,6 +61,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingPpp:
+ *
+ * Point-to-Point Protocol Settings
  */
 struct _NMSettingPpp {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-pppoe.h b/libnm-core/nm-setting-pppoe.h
index 56d42efd3b..b6717cde81 100644
--- a/libnm-core/nm-setting-pppoe.h
+++ b/libnm-core/nm-setting-pppoe.h
@@ -47,6 +47,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingPppoe:
+ *
+ * PPP-over-Ethernet Settings
  */
 struct _NMSettingPppoe {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-proxy.h b/libnm-core/nm-setting-proxy.h
index e80789b4ac..0c72799f80 100644
--- a/libnm-core/nm-setting-proxy.h
+++ b/libnm-core/nm-setting-proxy.h
@@ -58,6 +58,11 @@ typedef enum {
 #define NM_SETTING_PROXY_PAC_URL "pac-url"
 #define NM_SETTING_PROXY_PAC_SCRIPT "pac-script"
 
+/**
+ * NMSettingProxy:
+ *
+ * WWW Proxy Settings
+ */
 struct _NMSettingProxy {
 	NMSetting parent;
 };
diff --git a/libnm-core/nm-setting-serial.h b/libnm-core/nm-setting-serial.h
index 16cad3fae2..2362b2463e 100644
--- a/libnm-core/nm-setting-serial.h
+++ b/libnm-core/nm-setting-serial.h
@@ -62,6 +62,8 @@ typedef enum {
 
 /**
  * NMSettingSerial:
+ *
+ * Serial Link Settings
  */
 struct _NMSettingSerial {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-team-port.h b/libnm-core/nm-setting-team-port.h
index 3b9dc09e2f..4fcc51083a 100644
--- a/libnm-core/nm-setting-team-port.h
+++ b/libnm-core/nm-setting-team-port.h
@@ -42,6 +42,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingTeamPort:
+ *
+ * Team Port Settings
  */
 struct _NMSettingTeamPort {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-team.h b/libnm-core/nm-setting-team.h
index baaa073d4c..532963aacb 100644
--- a/libnm-core/nm-setting-team.h
+++ b/libnm-core/nm-setting-team.h
@@ -42,6 +42,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingTeam:
+ *
+ * Teaming Settings
  */
 struct _NMSettingTeam {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-tun.h b/libnm-core/nm-setting-tun.h
index 63c0cbd8cb..d977e381fa 100644
--- a/libnm-core/nm-setting-tun.h
+++ b/libnm-core/nm-setting-tun.h
@@ -62,6 +62,8 @@ typedef enum {
 
 /**
  * NMSettingTun:
+ *
+ * Tunnel Settings
  */
 struct _NMSettingTun {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-vlan.h b/libnm-core/nm-setting-vlan.h
index b147a18574..ec41b59504 100644
--- a/libnm-core/nm-setting-vlan.h
+++ b/libnm-core/nm-setting-vlan.h
@@ -48,6 +48,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingVlan:
+ *
+ * VLAN Settings
  */
 struct _NMSettingVlan {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-vpn.h b/libnm-core/nm-setting-vpn.h
index 79f3d642b7..115aa8676e 100644
--- a/libnm-core/nm-setting-vpn.h
+++ b/libnm-core/nm-setting-vpn.h
@@ -49,6 +49,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingVpn:
+ *
+ * VPN Settings
  */
 struct _NMSettingVpn {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-vxlan.h b/libnm-core/nm-setting-vxlan.h
index fab2d8201d..ce26694119 100644
--- a/libnm-core/nm-setting-vxlan.h
+++ b/libnm-core/nm-setting-vxlan.h
@@ -58,6 +58,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingVxlan:
+ *
+ * VXLAN Settings
  */
 struct _NMSettingVxlan {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-wimax.h b/libnm-core/nm-setting-wimax.h
index b9c86f3ace..fb0abbac9f 100644
--- a/libnm-core/nm-setting-wimax.h
+++ b/libnm-core/nm-setting-wimax.h
@@ -44,6 +44,8 @@ G_BEGIN_DECLS
 
 /**
  * NMSettingWimax:
+ *
+ * WiMax Settings
  */
 struct _NMSettingWimax {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-wired.h b/libnm-core/nm-setting-wired.h
index 0978ae90fc..015f09da3f 100644
--- a/libnm-core/nm-setting-wired.h
+++ b/libnm-core/nm-setting-wired.h
@@ -96,6 +96,8 @@ typedef enum { /*< flags >*/
 
 /**
  * NMSettingWired:
+ *
+ * Wired Ethernet Settings
  */
 struct _NMSettingWired {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-wireless-security.h b/libnm-core/nm-setting-wireless-security.h
index 290d4f265f..ae252f1124 100644
--- a/libnm-core/nm-setting-wireless-security.h
+++ b/libnm-core/nm-setting-wireless-security.h
@@ -91,6 +91,8 @@ typedef enum {
 
 /**
  * NMSettingWirelessSecurity:
+ *
+ * Wi-Fi Security Settings
  */
 struct _NMSettingWirelessSecurity {
 	NMSetting parent;
diff --git a/libnm-core/nm-setting-wireless.h b/libnm-core/nm-setting-wireless.h
index 1d58903fc1..b0ef475682 100644
--- a/libnm-core/nm-setting-wireless.h
+++ b/libnm-core/nm-setting-wireless.h
@@ -101,6 +101,8 @@ typedef enum {
 
 /**
  * NMSettingWireless:
+ *
+ * Wi-Fi Settings
  */
 struct _NMSettingWireless {
 	NMSetting parent;