Commit 7bd69aa0 authored by Lubomir Rintel's avatar Lubomir Rintel 🥕

libnm-core: sensible docstrings for NMSettings*

parent f6e9b1d3
...@@ -174,6 +174,8 @@ typedef enum { /*< underscore_name=nm_setting_802_1x_auth_flags >*/ ...@@ -174,6 +174,8 @@ typedef enum { /*< underscore_name=nm_setting_802_1x_auth_flags >*/
/** /**
* NMSetting8021x: * NMSetting8021x:
*
* AIEEE 802.1x Authentication Settings
*/ */
struct _NMSetting8021x { struct _NMSetting8021x {
NMSetting parent; NMSetting parent;
......
...@@ -56,6 +56,8 @@ G_BEGIN_DECLS ...@@ -56,6 +56,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingAdsl: * NMSettingAdsl:
*
* ADSL Settings
*/ */
struct _NMSettingAdsl { struct _NMSettingAdsl {
NMSetting parent; NMSetting parent;
......
...@@ -61,6 +61,8 @@ G_BEGIN_DECLS ...@@ -61,6 +61,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingBluetooth: * NMSettingBluetooth:
*
* Bluetooth Settings
*/ */
struct _NMSettingBluetooth { struct _NMSettingBluetooth {
NMSetting parent; NMSetting parent;
......
...@@ -72,6 +72,8 @@ G_BEGIN_DECLS ...@@ -72,6 +72,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingBond: * NMSettingBond:
*
* Bonding Settings
*/ */
struct _NMSettingBond { struct _NMSettingBond {
NMSetting parent; NMSetting parent;
......
...@@ -45,6 +45,8 @@ G_BEGIN_DECLS ...@@ -45,6 +45,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingBridgePort: * NMSettingBridgePort:
*
* Bridge Port Settings
*/ */
struct _NMSettingBridgePort { struct _NMSettingBridgePort {
NMSetting parent; NMSetting parent;
......
...@@ -50,6 +50,8 @@ G_BEGIN_DECLS ...@@ -50,6 +50,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingBridge: * NMSettingBridge:
*
* Bridging Settings
*/ */
struct _NMSettingBridge { struct _NMSettingBridge {
NMSetting parent; NMSetting parent;
......
...@@ -48,6 +48,8 @@ G_BEGIN_DECLS ...@@ -48,6 +48,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingCdma: * NMSettingCdma:
*
* CDMA-based Mobile Broadband Settings
*/ */
struct _NMSettingCdma { struct _NMSettingCdma {
NMSetting parent; NMSetting parent;
......
...@@ -99,8 +99,7 @@ typedef enum { ...@@ -99,8 +99,7 @@ typedef enum {
/** /**
* NMSettingConnection: * NMSettingConnection:
* *
* The NMSettingConnection struct contains only private data. * General Connection Profile Settings
* It should only be accessed through the functions described below.
*/ */
struct _NMSettingConnection { struct _NMSettingConnection {
NMSetting parent; NMSetting parent;
......
...@@ -94,6 +94,8 @@ typedef enum { /*< flags >*/ ...@@ -94,6 +94,8 @@ typedef enum { /*< flags >*/
/** /**
* NMSettingDcb: * NMSettingDcb:
*
* Data Center Bridging Settings
*/ */
struct _NMSettingDcb { struct _NMSettingDcb {
NMSetting parent; NMSetting parent;
......
...@@ -41,6 +41,8 @@ G_BEGIN_DECLS ...@@ -41,6 +41,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingDummy: * NMSettingDummy:
*
* Dummy Link Settings
*/ */
struct _NMSettingDummy { struct _NMSettingDummy {
NMSetting parent; NMSetting parent;
......
...@@ -41,6 +41,8 @@ G_BEGIN_DECLS ...@@ -41,6 +41,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingGeneric: * NMSettingGeneric:
*
* Generic Link Settings
*/ */
struct _NMSettingGeneric { struct _NMSettingGeneric {
NMSetting parent; NMSetting parent;
......
...@@ -56,6 +56,8 @@ G_BEGIN_DECLS ...@@ -56,6 +56,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingGsm: * NMSettingGsm:
*
* GSM-based Mobile Broadband Settings
*/ */
struct _NMSettingGsm { struct _NMSettingGsm {
NMSetting parent; NMSetting parent;
......
...@@ -47,6 +47,8 @@ G_BEGIN_DECLS ...@@ -47,6 +47,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingInfiniband: * NMSettingInfiniband:
*
* Infiniband Settings
*/ */
struct _NMSettingInfiniband { struct _NMSettingInfiniband {
NMSetting parent; NMSetting parent;
......
...@@ -53,6 +53,8 @@ G_BEGIN_DECLS ...@@ -53,6 +53,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingIPTunnel: * NMSettingIPTunnel:
*
* IP Tunneling Settings
*/ */
struct _NMSettingIPTunnel { struct _NMSettingIPTunnel {
NMSetting parent; NMSetting parent;
......
...@@ -89,6 +89,8 @@ G_BEGIN_DECLS ...@@ -89,6 +89,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingIP4Config: * NMSettingIP4Config:
*
* IPv4 Settings
*/ */
struct _NMSettingIP4Config { struct _NMSettingIP4Config {
NMSettingIPConfig parent; NMSettingIPConfig parent;
......
...@@ -139,6 +139,8 @@ typedef enum { ...@@ -139,6 +139,8 @@ typedef enum {
/** /**
* NMSettingIP6Config: * NMSettingIP6Config:
*
* IPv6 Settings
*/ */
struct _NMSettingIP6Config { struct _NMSettingIP6Config {
NMSettingIPConfig parent; NMSettingIPConfig parent;
......
...@@ -50,6 +50,8 @@ G_BEGIN_DECLS ...@@ -50,6 +50,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingMacsec: * NMSettingMacsec:
*
* MACSec Settings
*/ */
struct _NMSettingMacsec { struct _NMSettingMacsec {
NMSetting parent; NMSetting parent;
......
...@@ -46,6 +46,8 @@ G_BEGIN_DECLS ...@@ -46,6 +46,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingMacvlan: * NMSettingMacvlan:
*
* MAC VLAN Settings
*/ */
struct _NMSettingMacvlan { struct _NMSettingMacvlan {
NMSetting parent; NMSetting parent;
......
...@@ -46,6 +46,8 @@ G_BEGIN_DECLS ...@@ -46,6 +46,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingOlpcMesh: * NMSettingOlpcMesh:
*
* OLPC Wireless Mesh Settings
*/ */
struct _NMSettingOlpcMesh { struct _NMSettingOlpcMesh {
NMSetting parent; NMSetting parent;
......
...@@ -61,6 +61,8 @@ G_BEGIN_DECLS ...@@ -61,6 +61,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingPpp: * NMSettingPpp:
*
* Point-to-Point Protocol Settings
*/ */
struct _NMSettingPpp { struct _NMSettingPpp {
NMSetting parent; NMSetting parent;
......
...@@ -47,6 +47,8 @@ G_BEGIN_DECLS ...@@ -47,6 +47,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingPppoe: * NMSettingPppoe:
*
* PPP-over-Ethernet Settings
*/ */
struct _NMSettingPppoe { struct _NMSettingPppoe {
NMSetting parent; NMSetting parent;
......
...@@ -58,6 +58,11 @@ typedef enum { ...@@ -58,6 +58,11 @@ typedef enum {
#define NM_SETTING_PROXY_PAC_URL "pac-url" #define NM_SETTING_PROXY_PAC_URL "pac-url"
#define NM_SETTING_PROXY_PAC_SCRIPT "pac-script" #define NM_SETTING_PROXY_PAC_SCRIPT "pac-script"
/**
* NMSettingProxy:
*
* WWW Proxy Settings
*/
struct _NMSettingProxy { struct _NMSettingProxy {
NMSetting parent; NMSetting parent;
}; };
......
...@@ -62,6 +62,8 @@ typedef enum { ...@@ -62,6 +62,8 @@ typedef enum {
/** /**
* NMSettingSerial: * NMSettingSerial:
*
* Serial Link Settings
*/ */
struct _NMSettingSerial { struct _NMSettingSerial {
NMSetting parent; NMSetting parent;
......
...@@ -42,6 +42,8 @@ G_BEGIN_DECLS ...@@ -42,6 +42,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingTeamPort: * NMSettingTeamPort:
*
* Team Port Settings
*/ */
struct _NMSettingTeamPort { struct _NMSettingTeamPort {
NMSetting parent; NMSetting parent;
......
...@@ -42,6 +42,8 @@ G_BEGIN_DECLS ...@@ -42,6 +42,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingTeam: * NMSettingTeam:
*
* Teaming Settings
*/ */
struct _NMSettingTeam { struct _NMSettingTeam {
NMSetting parent; NMSetting parent;
......
...@@ -62,6 +62,8 @@ typedef enum { ...@@ -62,6 +62,8 @@ typedef enum {
/** /**
* NMSettingTun: * NMSettingTun:
*
* Tunnel Settings
*/ */
struct _NMSettingTun { struct _NMSettingTun {
NMSetting parent; NMSetting parent;
......
...@@ -48,6 +48,8 @@ G_BEGIN_DECLS ...@@ -48,6 +48,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingVlan: * NMSettingVlan:
*
* VLAN Settings
*/ */
struct _NMSettingVlan { struct _NMSettingVlan {
NMSetting parent; NMSetting parent;
......
...@@ -49,6 +49,8 @@ G_BEGIN_DECLS ...@@ -49,6 +49,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingVpn: * NMSettingVpn:
*
* VPN Settings
*/ */
struct _NMSettingVpn { struct _NMSettingVpn {
NMSetting parent; NMSetting parent;
......
...@@ -58,6 +58,8 @@ G_BEGIN_DECLS ...@@ -58,6 +58,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingVxlan: * NMSettingVxlan:
*
* VXLAN Settings
*/ */
struct _NMSettingVxlan { struct _NMSettingVxlan {
NMSetting parent; NMSetting parent;
......
...@@ -44,6 +44,8 @@ G_BEGIN_DECLS ...@@ -44,6 +44,8 @@ G_BEGIN_DECLS
/** /**
* NMSettingWimax: * NMSettingWimax:
*
* WiMax Settings
*/ */
struct _NMSettingWimax { struct _NMSettingWimax {
NMSetting parent; NMSetting parent;
......
...@@ -96,6 +96,8 @@ typedef enum { /*< flags >*/ ...@@ -96,6 +96,8 @@ typedef enum { /*< flags >*/
/** /**
* NMSettingWired: * NMSettingWired:
*
* Wired Ethernet Settings
*/ */
struct _NMSettingWired { struct _NMSettingWired {
NMSetting parent; NMSetting parent;
......
...@@ -91,6 +91,8 @@ typedef enum { ...@@ -91,6 +91,8 @@ typedef enum {
/** /**
* NMSettingWirelessSecurity: * NMSettingWirelessSecurity:
*
* Wi-Fi Security Settings
*/ */
struct _NMSettingWirelessSecurity { struct _NMSettingWirelessSecurity {
NMSetting parent; NMSetting parent;
......
...@@ -101,6 +101,8 @@ typedef enum { ...@@ -101,6 +101,8 @@ typedef enum {
/** /**
* NMSettingWireless: * NMSettingWireless:
*
* Wi-Fi Settings
*/ */
struct _NMSettingWireless { struct _NMSettingWireless {
NMSetting parent; NMSetting parent;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment