summaryrefslogtreecommitdiff
path: root/libnm-core
diff options
context:
space:
mode:
authorBeniamino Galvani <bgalvani@redhat.com>2016-05-05 09:36:32 +0200
committerBeniamino Galvani <bgalvani@redhat.com>2016-05-05 17:01:57 +0200
commitf1d23c32c3622d55c13304d025eb1f55f7774578 (patch)
tree4c24e33c15b99415314823e5494e8ba6c3b790a2 /libnm-core
parenta51a43fc848edec39db33b50e333000c2b4363b2 (diff)
downloadNetworkManager-f1d23c32c3622d55c13304d025eb1f55f7774578.tar.gz
docs: libnm: add doc comment to types
This is required to add objects in the "Types and Values" section and in the API index. Later, we may want to add useful content in those empty comments.
Diffstat (limited to 'libnm-core')
-rw-r--r--libnm-core/nm-setting-8021x.h3
-rw-r--r--libnm-core/nm-setting-adsl.h3
-rw-r--r--libnm-core/nm-setting-bluetooth.h3
-rw-r--r--libnm-core/nm-setting-bond.h3
-rw-r--r--libnm-core/nm-setting-bridge-port.h3
-rw-r--r--libnm-core/nm-setting-bridge.h3
-rw-r--r--libnm-core/nm-setting-cdma.h3
-rw-r--r--libnm-core/nm-setting-dcb.h4
-rw-r--r--libnm-core/nm-setting-generic.h3
-rw-r--r--libnm-core/nm-setting-gsm.h3
-rw-r--r--libnm-core/nm-setting-infiniband.h3
-rw-r--r--libnm-core/nm-setting-ip-config.h3
-rw-r--r--libnm-core/nm-setting-ip-tunnel.h3
-rw-r--r--libnm-core/nm-setting-ip4-config.h3
-rw-r--r--libnm-core/nm-setting-ip6-config.h3
-rw-r--r--libnm-core/nm-setting-macvlan.h3
-rw-r--r--libnm-core/nm-setting-olpc-mesh.h3
-rw-r--r--libnm-core/nm-setting-ppp.h3
-rw-r--r--libnm-core/nm-setting-pppoe.h3
-rw-r--r--libnm-core/nm-setting-serial.h3
-rw-r--r--libnm-core/nm-setting-team-port.h3
-rw-r--r--libnm-core/nm-setting-team.h3
-rw-r--r--libnm-core/nm-setting-tun.h3
-rw-r--r--libnm-core/nm-setting-vlan.h3
-rw-r--r--libnm-core/nm-setting-vpn.h3
-rw-r--r--libnm-core/nm-setting-vxlan.h3
-rw-r--r--libnm-core/nm-setting-wimax.h3
-rw-r--r--libnm-core/nm-setting-wired.h3
-rw-r--r--libnm-core/nm-setting-wireless-security.h3
-rw-r--r--libnm-core/nm-setting-wireless.h4
-rw-r--r--libnm-core/nm-simple-connection.h3
-rw-r--r--libnm-core/nm-vpn-plugin-info.h3
32 files changed, 96 insertions, 2 deletions
diff --git a/libnm-core/nm-setting-8021x.h b/libnm-core/nm-setting-8021x.h
index d8867b9261..5cdcb3d5bc 100644
--- a/libnm-core/nm-setting-8021x.h
+++ b/libnm-core/nm-setting-8021x.h
@@ -136,6 +136,9 @@ typedef enum { /*< underscore_name=nm_setting_802_1x_ck_scheme >*/
* properties to the paths to their respective objects.
*/
+/**
+ * NMSetting8021x:
+ */
struct _NMSetting8021x {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-adsl.h b/libnm-core/nm-setting-adsl.h
index 2b44d68687..5afbe5bffc 100644
--- a/libnm-core/nm-setting-adsl.h
+++ b/libnm-core/nm-setting-adsl.h
@@ -54,6 +54,9 @@ G_BEGIN_DECLS
#define NM_SETTING_ADSL_ENCAPSULATION_VCMUX "vcmux"
#define NM_SETTING_ADSL_ENCAPSULATION_LLC "llc"
+/**
+ * NMSettingAdsl:
+ */
struct _NMSettingAdsl {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-bluetooth.h b/libnm-core/nm-setting-bluetooth.h
index 6bb5ce80a4..6746782e7c 100644
--- a/libnm-core/nm-setting-bluetooth.h
+++ b/libnm-core/nm-setting-bluetooth.h
@@ -59,6 +59,9 @@ G_BEGIN_DECLS
*/
#define NM_SETTING_BLUETOOTH_TYPE_PANU "panu"
+/**
+ * NMSettingBluetooth:
+ */
struct _NMSettingBluetooth {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-bond.h b/libnm-core/nm-setting-bond.h
index 98fcc6d0fa..8ee31888a8 100644
--- a/libnm-core/nm-setting-bond.h
+++ b/libnm-core/nm-setting-bond.h
@@ -70,6 +70,9 @@ G_BEGIN_DECLS
#define NM_SETTING_BOND_OPTION_TLB_DYNAMIC_LB "tlb_dynamic_lb"
#define NM_SETTING_BOND_OPTION_LP_INTERVAL "lp_interval"
+/**
+ * NMSettingBond:
+ */
struct _NMSettingBond {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-bridge-port.h b/libnm-core/nm-setting-bridge-port.h
index 49ca38b34e..b43f636608 100644
--- a/libnm-core/nm-setting-bridge-port.h
+++ b/libnm-core/nm-setting-bridge-port.h
@@ -43,6 +43,9 @@ G_BEGIN_DECLS
#define NM_SETTING_BRIDGE_PORT_PATH_COST "path-cost"
#define NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE "hairpin-mode"
+/**
+ * NMSettingBridgePort:
+ */
struct _NMSettingBridgePort {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-bridge.h b/libnm-core/nm-setting-bridge.h
index 020d6db63b..844c06ad38 100644
--- a/libnm-core/nm-setting-bridge.h
+++ b/libnm-core/nm-setting-bridge.h
@@ -48,6 +48,9 @@ G_BEGIN_DECLS
#define NM_SETTING_BRIDGE_AGEING_TIME "ageing-time"
#define NM_SETTING_BRIDGE_MULTICAST_SNOOPING "multicast-snooping"
+/**
+ * NMSettingBridge:
+ */
struct _NMSettingBridge {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-cdma.h b/libnm-core/nm-setting-cdma.h
index 6e333dccc9..091c530ed8 100644
--- a/libnm-core/nm-setting-cdma.h
+++ b/libnm-core/nm-setting-cdma.h
@@ -45,6 +45,9 @@ G_BEGIN_DECLS
#define NM_SETTING_CDMA_PASSWORD "password"
#define NM_SETTING_CDMA_PASSWORD_FLAGS "password-flags"
+/**
+ * NMSettingCdma:
+ */
struct _NMSettingCdma {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-dcb.h b/libnm-core/nm-setting-dcb.h
index e5bc4bcfa7..6cc2ce41b5 100644
--- a/libnm-core/nm-setting-dcb.h
+++ b/libnm-core/nm-setting-dcb.h
@@ -92,7 +92,9 @@ typedef enum { /*< flags >*/
#define NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH "priority-strict-bandwidth"
#define NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS "priority-traffic-class"
-
+/**
+ * NMSettingDcb:
+ */
struct _NMSettingDcb {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-generic.h b/libnm-core/nm-setting-generic.h
index 7a209da259..0ce3b1605f 100644
--- a/libnm-core/nm-setting-generic.h
+++ b/libnm-core/nm-setting-generic.h
@@ -39,6 +39,9 @@ G_BEGIN_DECLS
#define NM_SETTING_GENERIC_SETTING_NAME "generic"
+/**
+ * NMSettingGeneric:
+ */
struct _NMSettingGeneric {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-gsm.h b/libnm-core/nm-setting-gsm.h
index 2dfe73fae2..7f97d38678 100644
--- a/libnm-core/nm-setting-gsm.h
+++ b/libnm-core/nm-setting-gsm.h
@@ -53,6 +53,9 @@ G_BEGIN_DECLS
#define NM_SETTING_GSM_SIM_ID "sim-id"
#define NM_SETTING_GSM_SIM_OPERATOR_ID "sim-operator-id"
+/**
+ * NMSettingGsm:
+ */
struct _NMSettingGsm {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-infiniband.h b/libnm-core/nm-setting-infiniband.h
index c5ad418b22..f19983b462 100644
--- a/libnm-core/nm-setting-infiniband.h
+++ b/libnm-core/nm-setting-infiniband.h
@@ -45,6 +45,9 @@ G_BEGIN_DECLS
#define NM_SETTING_INFINIBAND_P_KEY "p-key"
#define NM_SETTING_INFINIBAND_PARENT "parent"
+/**
+ * NMSettingInfiniband:
+ */
struct _NMSettingInfiniband {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-ip-config.h b/libnm-core/nm-setting-ip-config.h
index 39e4c9f083..79c7e63921 100644
--- a/libnm-core/nm-setting-ip-config.h
+++ b/libnm-core/nm-setting-ip-config.h
@@ -165,6 +165,9 @@ void nm_ip_route_set_attribute (NMIPRoute *route,
#define NM_SETTING_DNS_OPTION_NO_TLD_QUERY "no-tld-query"
#define NM_SETTING_DNS_OPTION_USE_VC "use-vc"
+/**
+ * NMSettingIPConfig:
+ */
struct _NMSettingIPConfig {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-ip-tunnel.h b/libnm-core/nm-setting-ip-tunnel.h
index 09814f350c..3ee4aafe44 100644
--- a/libnm-core/nm-setting-ip-tunnel.h
+++ b/libnm-core/nm-setting-ip-tunnel.h
@@ -51,6 +51,9 @@ G_BEGIN_DECLS
#define NM_SETTING_IP_TUNNEL_FLOW_LABEL "flow-label"
#define NM_SETTING_IP_TUNNEL_MTU "mtu"
+/**
+ * NMSettingIPTunnel:
+ */
struct _NMSettingIPTunnel {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-ip4-config.h b/libnm-core/nm-setting-ip4-config.h
index 8e6524cb4f..adef375464 100644
--- a/libnm-core/nm-setting-ip4-config.h
+++ b/libnm-core/nm-setting-ip4-config.h
@@ -87,6 +87,9 @@ G_BEGIN_DECLS
*/
#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled"
+/**
+ * NMSettingIP4Config:
+ */
struct _NMSettingIP4Config {
NMSettingIPConfig parent;
};
diff --git a/libnm-core/nm-setting-ip6-config.h b/libnm-core/nm-setting-ip6-config.h
index f8923d195f..2966e558cb 100644
--- a/libnm-core/nm-setting-ip6-config.h
+++ b/libnm-core/nm-setting-ip6-config.h
@@ -135,6 +135,9 @@ typedef enum {
NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY = 1,
} NMSettingIP6ConfigAddrGenMode;
+/**
+ * NMSettingIP6Config:
+ */
struct _NMSettingIP6Config {
NMSettingIPConfig parent;
};
diff --git a/libnm-core/nm-setting-macvlan.h b/libnm-core/nm-setting-macvlan.h
index 3922cd93f6..33860aacc2 100644
--- a/libnm-core/nm-setting-macvlan.h
+++ b/libnm-core/nm-setting-macvlan.h
@@ -44,6 +44,9 @@ G_BEGIN_DECLS
#define NM_SETTING_MACVLAN_PROMISCUOUS "promiscuous"
#define NM_SETTING_MACVLAN_TAP "tap"
+/**
+ * NMSettingMacvlan:
+ */
struct _NMSettingMacvlan {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-olpc-mesh.h b/libnm-core/nm-setting-olpc-mesh.h
index 6a1656514b..2506cec9c5 100644
--- a/libnm-core/nm-setting-olpc-mesh.h
+++ b/libnm-core/nm-setting-olpc-mesh.h
@@ -44,6 +44,9 @@ G_BEGIN_DECLS
#define NM_SETTING_OLPC_MESH_CHANNEL "channel"
#define NM_SETTING_OLPC_MESH_DHCP_ANYCAST_ADDRESS "dhcp-anycast-address"
+/**
+ * NMSettingOlpcMesh:
+ */
struct _NMSettingOlpcMesh {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-ppp.h b/libnm-core/nm-setting-ppp.h
index 2e0162cc59..a835ef8a05 100644
--- a/libnm-core/nm-setting-ppp.h
+++ b/libnm-core/nm-setting-ppp.h
@@ -59,6 +59,9 @@ G_BEGIN_DECLS
#define NM_SETTING_PPP_LCP_ECHO_FAILURE "lcp-echo-failure"
#define NM_SETTING_PPP_LCP_ECHO_INTERVAL "lcp-echo-interval"
+/**
+ * NMSettingPpp:
+ */
struct _NMSettingPpp {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-pppoe.h b/libnm-core/nm-setting-pppoe.h
index b1e0d92feb..1f5b6ed97c 100644
--- a/libnm-core/nm-setting-pppoe.h
+++ b/libnm-core/nm-setting-pppoe.h
@@ -45,6 +45,9 @@ G_BEGIN_DECLS
#define NM_SETTING_PPPOE_PASSWORD "password"
#define NM_SETTING_PPPOE_PASSWORD_FLAGS "password-flags"
+/**
+ * NMSettingPppoe:
+ */
struct _NMSettingPppoe {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-serial.h b/libnm-core/nm-setting-serial.h
index 582892277b..182efc6176 100644
--- a/libnm-core/nm-setting-serial.h
+++ b/libnm-core/nm-setting-serial.h
@@ -60,6 +60,9 @@ typedef enum {
#define NM_SETTING_SERIAL_STOPBITS "stopbits"
#define NM_SETTING_SERIAL_SEND_DELAY "send-delay"
+/**
+ * NMSettingSerial:
+ */
struct _NMSettingSerial {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-team-port.h b/libnm-core/nm-setting-team-port.h
index 86efb97c40..546cc69a9a 100644
--- a/libnm-core/nm-setting-team-port.h
+++ b/libnm-core/nm-setting-team-port.h
@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_SETTING_TEAM_PORT_CONFIG "config"
+/**
+ * NMSettingTeamPort:
+ */
struct _NMSettingTeamPort {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-team.h b/libnm-core/nm-setting-team.h
index d66eb6858a..726f84202a 100644
--- a/libnm-core/nm-setting-team.h
+++ b/libnm-core/nm-setting-team.h
@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_SETTING_TEAM_CONFIG "config"
+/**
+ * NMSettingTeam:
+ */
struct _NMSettingTeam {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-tun.h b/libnm-core/nm-setting-tun.h
index 2b368a694a..63c0cbd8cb 100644
--- a/libnm-core/nm-setting-tun.h
+++ b/libnm-core/nm-setting-tun.h
@@ -60,6 +60,9 @@ typedef enum {
NM_SETTING_TUN_MODE_TAP = 2,
} NMSettingTunMode;
+/**
+ * NMSettingTun:
+ */
struct _NMSettingTun {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-vlan.h b/libnm-core/nm-setting-vlan.h
index cf41ba177e..b147a18574 100644
--- a/libnm-core/nm-setting-vlan.h
+++ b/libnm-core/nm-setting-vlan.h
@@ -46,6 +46,9 @@ G_BEGIN_DECLS
#define NM_SETTING_VLAN_INGRESS_PRIORITY_MAP "ingress-priority-map"
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP "egress-priority-map"
+/**
+ * NMSettingVlan:
+ */
struct _NMSettingVlan {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-vpn.h b/libnm-core/nm-setting-vpn.h
index 31f3c7b87a..539656f826 100644
--- a/libnm-core/nm-setting-vpn.h
+++ b/libnm-core/nm-setting-vpn.h
@@ -47,6 +47,9 @@ G_BEGIN_DECLS
#define NM_SETTING_VPN_SECRETS "secrets"
#define NM_SETTING_VPN_TIMEOUT "timeout"
+/**
+ * NMSettingVpn:
+ */
struct _NMSettingVpn {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-vxlan.h b/libnm-core/nm-setting-vxlan.h
index c410338eeb..fab2d8201d 100644
--- a/libnm-core/nm-setting-vxlan.h
+++ b/libnm-core/nm-setting-vxlan.h
@@ -56,6 +56,9 @@ G_BEGIN_DECLS
#define NM_SETTING_VXLAN_L2_MISS "l2-miss"
#define NM_SETTING_VXLAN_L3_MISS "l3-miss"
+/**
+ * NMSettingVxlan:
+ */
struct _NMSettingVxlan {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-wimax.h b/libnm-core/nm-setting-wimax.h
index 0a98fbb5c5..3f0767e969 100644
--- a/libnm-core/nm-setting-wimax.h
+++ b/libnm-core/nm-setting-wimax.h
@@ -42,6 +42,9 @@ G_BEGIN_DECLS
#define NM_SETTING_WIMAX_NETWORK_NAME "network-name"
#define NM_SETTING_WIMAX_MAC_ADDRESS "mac-address"
+/**
+ * NMSettingWimax:
+ */
struct _NMSettingWimax {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-wired.h b/libnm-core/nm-setting-wired.h
index 7eb53d3021..6bc6678238 100644
--- a/libnm-core/nm-setting-wired.h
+++ b/libnm-core/nm-setting-wired.h
@@ -93,6 +93,9 @@ typedef enum { /*< flags >*/
#define NM_SETTING_WIRED_WAKE_ON_LAN "wake-on-lan"
#define NM_SETTING_WIRED_WAKE_ON_LAN_PASSWORD "wake-on-lan-password"
+/**
+ * NMSettingWired:
+ */
struct _NMSettingWired {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-wireless-security.h b/libnm-core/nm-setting-wireless-security.h
index 8c4e1f0382..093cb386cb 100644
--- a/libnm-core/nm-setting-wireless-security.h
+++ b/libnm-core/nm-setting-wireless-security.h
@@ -89,6 +89,9 @@ typedef enum {
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD "leap-password"
#define NM_SETTING_WIRELESS_SECURITY_LEAP_PASSWORD_FLAGS "leap-password-flags"
+/**
+ * NMSettingWirelessSecurity:
+ */
struct _NMSettingWirelessSecurity {
NMSetting parent;
};
diff --git a/libnm-core/nm-setting-wireless.h b/libnm-core/nm-setting-wireless.h
index 606733fa91..574cee54f2 100644
--- a/libnm-core/nm-setting-wireless.h
+++ b/libnm-core/nm-setting-wireless.h
@@ -98,7 +98,9 @@ typedef enum {
NM_SETTING_WIRELESS_POWERSAVE_LAST = _NM_SETTING_WIRELESS_POWERSAVE_NUM - 1, /*< skip >*/
} NMSettingWirelessPowersave;
-
+/**
+ * NMSettingWireless:
+ */
struct _NMSettingWireless {
NMSetting parent;
};
diff --git a/libnm-core/nm-simple-connection.h b/libnm-core/nm-simple-connection.h
index da6030a882..d6a6044713 100644
--- a/libnm-core/nm-simple-connection.h
+++ b/libnm-core/nm-simple-connection.h
@@ -36,6 +36,9 @@ G_BEGIN_DECLS
#define NM_IS_SIMPLE_CONNECTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SIMPLE_CONNECTION))
#define NM_SIMPLE_CONNECTION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SIMPLE_CONNECTION, NMSimpleConnectionClass))
+/**
+ * NMSimpleConnection:
+ */
struct _NMSimpleConnection {
GObject parent;
};
diff --git a/libnm-core/nm-vpn-plugin-info.h b/libnm-core/nm-vpn-plugin-info.h
index 9844625cfc..b9ed83f1dc 100644
--- a/libnm-core/nm-vpn-plugin-info.h
+++ b/libnm-core/nm-vpn-plugin-info.h
@@ -44,6 +44,9 @@ G_BEGIN_DECLS
#define NM_VPN_PLUGIN_INFO_KF_GROUP_LIBNM "libnm"
#define NM_VPN_PLUGIN_INFO_KF_GROUP_GNOME "GNOME"
+/**
+ * NMVpnPluginInfo:
+ */
typedef struct {
NM_AVAILABLE_IN_1_2
GObject parent;