mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-01-07 23:00:19 +01:00
libnm-core: sensible docstrings for NMSettings*
This commit is contained in:
parent
f6e9b1d328
commit
7bd69aa08d
33 changed files with 68 additions and 2 deletions
|
|
@ -174,6 +174,8 @@ typedef enum { /*< underscore_name=nm_setting_802_1x_auth_flags >*/
|
|||
|
||||
/**
|
||||
* NMSetting8021x:
|
||||
*
|
||||
* AIEEE 802.1x Authentication Settings
|
||||
*/
|
||||
struct _NMSetting8021x {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -56,6 +56,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingAdsl:
|
||||
*
|
||||
* ADSL Settings
|
||||
*/
|
||||
struct _NMSettingAdsl {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -61,6 +61,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingBluetooth:
|
||||
*
|
||||
* Bluetooth Settings
|
||||
*/
|
||||
struct _NMSettingBluetooth {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -72,6 +72,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingBond:
|
||||
*
|
||||
* Bonding Settings
|
||||
*/
|
||||
struct _NMSettingBond {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -45,6 +45,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingBridgePort:
|
||||
*
|
||||
* Bridge Port Settings
|
||||
*/
|
||||
struct _NMSettingBridgePort {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -50,6 +50,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingBridge:
|
||||
*
|
||||
* Bridging Settings
|
||||
*/
|
||||
struct _NMSettingBridge {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -48,6 +48,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingCdma:
|
||||
*
|
||||
* CDMA-based Mobile Broadband Settings
|
||||
*/
|
||||
struct _NMSettingCdma {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -94,6 +94,8 @@ typedef enum { /*< flags >*/
|
|||
|
||||
/**
|
||||
* NMSettingDcb:
|
||||
*
|
||||
* Data Center Bridging Settings
|
||||
*/
|
||||
struct _NMSettingDcb {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingDummy:
|
||||
*
|
||||
* Dummy Link Settings
|
||||
*/
|
||||
struct _NMSettingDummy {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingGeneric:
|
||||
*
|
||||
* Generic Link Settings
|
||||
*/
|
||||
struct _NMSettingGeneric {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -56,6 +56,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingGsm:
|
||||
*
|
||||
* GSM-based Mobile Broadband Settings
|
||||
*/
|
||||
struct _NMSettingGsm {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -47,6 +47,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingInfiniband:
|
||||
*
|
||||
* Infiniband Settings
|
||||
*/
|
||||
struct _NMSettingInfiniband {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -53,6 +53,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingIPTunnel:
|
||||
*
|
||||
* IP Tunneling Settings
|
||||
*/
|
||||
struct _NMSettingIPTunnel {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -89,6 +89,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingIP4Config:
|
||||
*
|
||||
* IPv4 Settings
|
||||
*/
|
||||
struct _NMSettingIP4Config {
|
||||
NMSettingIPConfig parent;
|
||||
|
|
|
|||
|
|
@ -139,6 +139,8 @@ typedef enum {
|
|||
|
||||
/**
|
||||
* NMSettingIP6Config:
|
||||
*
|
||||
* IPv6 Settings
|
||||
*/
|
||||
struct _NMSettingIP6Config {
|
||||
NMSettingIPConfig parent;
|
||||
|
|
|
|||
|
|
@ -50,6 +50,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingMacsec:
|
||||
*
|
||||
* MACSec Settings
|
||||
*/
|
||||
struct _NMSettingMacsec {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingMacvlan:
|
||||
*
|
||||
* MAC VLAN Settings
|
||||
*/
|
||||
struct _NMSettingMacvlan {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -46,6 +46,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingOlpcMesh:
|
||||
*
|
||||
* OLPC Wireless Mesh Settings
|
||||
*/
|
||||
struct _NMSettingOlpcMesh {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -61,6 +61,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingPpp:
|
||||
*
|
||||
* Point-to-Point Protocol Settings
|
||||
*/
|
||||
struct _NMSettingPpp {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -47,6 +47,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingPppoe:
|
||||
*
|
||||
* PPP-over-Ethernet Settings
|
||||
*/
|
||||
struct _NMSettingPppoe {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
};
|
||||
|
|
|
|||
|
|
@ -62,6 +62,8 @@ typedef enum {
|
|||
|
||||
/**
|
||||
* NMSettingSerial:
|
||||
*
|
||||
* Serial Link Settings
|
||||
*/
|
||||
struct _NMSettingSerial {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingTeamPort:
|
||||
*
|
||||
* Team Port Settings
|
||||
*/
|
||||
struct _NMSettingTeamPort {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -42,6 +42,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingTeam:
|
||||
*
|
||||
* Teaming Settings
|
||||
*/
|
||||
struct _NMSettingTeam {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -62,6 +62,8 @@ typedef enum {
|
|||
|
||||
/**
|
||||
* NMSettingTun:
|
||||
*
|
||||
* Tunnel Settings
|
||||
*/
|
||||
struct _NMSettingTun {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -48,6 +48,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingVlan:
|
||||
*
|
||||
* VLAN Settings
|
||||
*/
|
||||
struct _NMSettingVlan {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -49,6 +49,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingVpn:
|
||||
*
|
||||
* VPN Settings
|
||||
*/
|
||||
struct _NMSettingVpn {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -58,6 +58,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingVxlan:
|
||||
*
|
||||
* VXLAN Settings
|
||||
*/
|
||||
struct _NMSettingVxlan {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -44,6 +44,8 @@ G_BEGIN_DECLS
|
|||
|
||||
/**
|
||||
* NMSettingWimax:
|
||||
*
|
||||
* WiMax Settings
|
||||
*/
|
||||
struct _NMSettingWimax {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -96,6 +96,8 @@ typedef enum { /*< flags >*/
|
|||
|
||||
/**
|
||||
* NMSettingWired:
|
||||
*
|
||||
* Wired Ethernet Settings
|
||||
*/
|
||||
struct _NMSettingWired {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -91,6 +91,8 @@ typedef enum {
|
|||
|
||||
/**
|
||||
* NMSettingWirelessSecurity:
|
||||
*
|
||||
* Wi-Fi Security Settings
|
||||
*/
|
||||
struct _NMSettingWirelessSecurity {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
|
|
@ -101,6 +101,8 @@ typedef enum {
|
|||
|
||||
/**
|
||||
* NMSettingWireless:
|
||||
*
|
||||
* Wi-Fi Settings
|
||||
*/
|
||||
struct _NMSettingWireless {
|
||||
NMSetting parent;
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue