Commit f1d23c32 authored by Beniamino Galvani's avatar Beniamino Galvani

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.
parent a51a43fc
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -59,6 +59,9 @@ G_BEGIN_DECLS
*/
#define NM_SETTING_BLUETOOTH_TYPE_PANU "panu"
/**
* NMSettingBluetooth:
*/
struct _NMSettingBluetooth {
NMSetting parent;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -39,6 +39,9 @@ G_BEGIN_DECLS
#define NM_SETTING_GENERIC_SETTING_NAME "generic"
/**
* NMSettingGeneric:
*/
struct _NMSettingGeneric {
NMSetting parent;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -87,6 +87,9 @@ G_BEGIN_DECLS
*/
#define NM_SETTING_IP4_CONFIG_METHOD_DISABLED "disabled"
/**
* NMSettingIP4Config:
*/
struct _NMSettingIP4Config {
NMSettingIPConfig parent;
};
......
......@@ -135,6 +135,9 @@ typedef enum {
NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY = 1,
} NMSettingIP6ConfigAddrGenMode;
/**
* NMSettingIP6Config:
*/
struct _NMSettingIP6Config {
NMSettingIPConfig parent;
};
......
......@@ -44,6 +44,9 @@ G_BEGIN_DECLS
#define NM_SETTING_MACVLAN_PROMISCUOUS "promiscuous"
#define NM_SETTING_MACVLAN_TAP "tap"
/**
* NMSettingMacvlan:
*/
struct _NMSettingMacvlan {
NMSetting parent;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_SETTING_TEAM_PORT_CONFIG "config"
/**
* NMSettingTeamPort:
*/
struct _NMSettingTeamPort {
NMSetting parent;
};
......
......@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_SETTING_TEAM_CONFIG "config"
/**
* NMSettingTeam:
*/
struct _NMSettingTeam {
NMSetting parent;
};
......
......@@ -60,6 +60,9 @@ typedef enum {
NM_SETTING_TUN_MODE_TAP = 2,
} NMSettingTunMode;
/**
* NMSettingTun:
*/
struct _NMSettingTun {
NMSetting parent;
};
......
......@@ -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;
};
......
......@@ -47,6 +47,9 @@ G_BEGIN_DECLS
#define NM_SETTING_VPN_SECRETS "secrets"
#define NM_SETTING_VPN_TIMEOUT "timeout"
/**
* NMSettingVpn:
*/
struct _NMSettingVpn {
NMSetting parent;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -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;
};
......
......@@ -98,7 +98,9 @@ typedef enum {
NM_SETTING_WIRELESS_POWERSAVE_LAST = _NM_SETTING_WIRELESS_POWERSAVE_NUM - 1, /*< skip >*/
} NMSettingWirelessPowersave;
/**
* NMSettingWireless:
*/
struct _NMSettingWireless {
NMSetting parent;
};
......
......@@ -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;
};
......
......@@ -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;
......
......@@ -51,7 +51,9 @@ G_BEGIN_DECLS
/* DEPRECATED */
#define NM_ACCESS_POINT_HW_ADDRESS "hw-address"
/**
* NMAccessPoint:
*/
struct _NMAccessPoint {
NMObject parent;
};
......
......@@ -53,6 +53,9 @@ G_BEGIN_DECLS
#define NM_ACTIVE_CONNECTION_VPN "vpn"
#define NM_ACTIVE_CONNECTION_MASTER "master"
/**
* NMActiveConnection:
*/
struct _NMActiveConnection {
NMObject parent;
};
......
......@@ -157,6 +157,9 @@ typedef enum {
#define NM_CLIENT_ERROR nm_client_error_quark ()
GQuark nm_client_error_quark (void);
/**
* NMClient:
*/
struct _NMClient {
GObject parent;
};
......
......@@ -38,6 +38,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_ADSL_CARRIER "carrier"
/**
* NMDeviceAdsl:
*/
struct _NMDeviceAdsl {
NMDevice parent;
};
......
......@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_BOND_CARRIER "carrier"
#define NM_DEVICE_BOND_SLAVES "slaves"
/**
* NMDeviceBond:
*/
struct _NMDeviceBond {
NMDevice parent;
};
......
......@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_BRIDGE_CARRIER "carrier"
#define NM_DEVICE_BRIDGE_SLAVES "slaves"
/**
* NMDeviceBridge:
*/
struct _NMDeviceBridge {
NMDevice parent;
};
......
......@@ -41,6 +41,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_BT_NAME "name"
#define NM_DEVICE_BT_CAPABILITIES "bt-capabilities"
/**
* NMDeviceBt:
*/
struct _NMDeviceBt {
NMDevice parent;
};
......
......@@ -43,6 +43,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_ETHERNET_CARRIER "carrier"
#define NM_DEVICE_ETHERNET_S390_SUBCHANNELS "s390-subchannels"
/**
* NMDeviceEthernet:
*/
struct _NMDeviceEthernet {
NMDevice parent;
};
......
......@@ -39,6 +39,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_GENERIC_HW_ADDRESS "hw-address"
#define NM_DEVICE_GENERIC_TYPE_DESCRIPTION "type-description"
/**
* NMDeviceGeneric:
*/
struct _NMDeviceGeneric {
NMDevice parent;
};
......
......@@ -39,6 +39,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_INFINIBAND_HW_ADDRESS "hw-address"
#define NM_DEVICE_INFINIBAND_CARRIER "carrier"
/**
* NMDeviceInfiniband:
*/
struct _NMDeviceInfiniband {
NMDevice parent;
};
......
......@@ -48,6 +48,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_IP_TUNNEL_ENCAPSULATION_LIMIT "encapsulation-limit"
#define NM_DEVICE_IP_TUNNEL_FLOW_LABEL "flow-label"
/**
* NMDeviceIPTunnel:
*/
struct _NMDeviceIPTunnel {
NMDevice parent;
};
......
......@@ -42,6 +42,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_MACVLAN_TAP "tap"
#define NM_DEVICE_MACVLAN_HW_ADDRESS "hw-address"
/**
* NMDeviceMacvlan:
*/
struct _NMDeviceMacvlan {
NMDevice parent;
};
......
......@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_MODEM_MODEM_CAPABILITIES "modem-capabilities"
#define NM_DEVICE_MODEM_CURRENT_CAPABILITIES "current-capabilities"
/**
* NMDeviceModem:
*/
struct _NMDeviceModem {
NMDevice parent;
};
......
......@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_OLPC_MESH_COMPANION "companion"
#define NM_DEVICE_OLPC_MESH_ACTIVE_CHANNEL "active-channel"
/**
* NMDeviceOlpcMesh:
*/
struct _NMDeviceOlpcMesh {
NMDevice parent;
};
......
......@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_TEAM_CARRIER "carrier"
#define NM_DEVICE_TEAM_SLAVES "slaves"
/**
* NMDeviceTeam:
*/
struct _NMDeviceTeam {
NMDevice parent;
};
......
......@@ -44,6 +44,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_TUN_VNET_HDR "vnet-hdr"
#define NM_DEVICE_TUN_MULTI_QUEUE "multi-queue"
/**
* NMDeviceTun:
*/
struct _NMDeviceTun {
NMDevice parent;
};
......
......@@ -41,6 +41,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_VLAN_PARENT "parent"
#define NM_DEVICE_VLAN_VLAN_ID "vlan-id"
/**
* NMDeviceVlan:
*/
struct _NMDeviceVlan {
NMDevice parent;
};
......
......@@ -55,6 +55,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_VXLAN_L3MISS "l3miss"
#define NM_DEVICE_VXLAN_DST_PORT "dst-port"
/**
* NMDeviceVxlan:
*/
struct _NMDeviceVxlan {
NMDevice parent;
};
......
......@@ -45,6 +45,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_WIFI_CAPABILITIES "wireless-capabilities"
#define NM_DEVICE_WIFI_ACCESS_POINTS "access-points"
/**
* NMDeviceWifi:
*/
struct _NMDeviceWifi {
NMDevice parent;
};
......
......@@ -46,6 +46,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_WIMAX_BSID "bsid"
#define NM_DEVICE_WIMAX_NSPS "nsps"
/**
* NMDeviceWimax:
*/
struct _NMDeviceWimax {
NMDevice parent;
};
......
......@@ -65,6 +65,9 @@ G_BEGIN_DECLS
#define NM_DEVICE_METERED "metered"
#define NM_DEVICE_LLDP_NEIGHBORS "lldp-neighbors"
/**
* NMDevice:
*/
struct _NMDevice {
NMObject parent;
};
......
......@@ -36,6 +36,9 @@ G_BEGIN_DECLS
#define NM_IS_DHCP_CONFIG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DHCP_CONFIG))
#define NM_IS_DHCP_CONFIG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_DHCP_CONFIG))
/**
* NMDhcpConfig:
*/
struct _NMDhcpConfig {
NMObject parent;
};
......
......@@ -31,6 +31,9 @@ G_BEGIN_DECLS
#define NM_IS_DHCP4_CONFIG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DHCP4_CONFIG))
#define NM_IS_DHCP4_CONFIG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_DHCP4_CONFIG))
/**
* NMDhcp4Config:
*/
typedef struct {
NMDhcpConfig parent;
} NMDhcp4Config;
......
......@@ -31,6 +31,9 @@ G_BEGIN_DECLS
#define NM_IS_DHCP6_CONFIG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DHCP6_CONFIG))
#define NM_IS_DHCP6_CONFIG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_DHCP6_CONFIG))
/**
* NMDhcp6Config:
*/
typedef struct {
NMDhcpConfig parent;
} NMDhcp6Config;
......
......@@ -37,6 +37,9 @@ G_BEGIN_DECLS
#define NM_IS_IP_CONFIG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_IP_CONFIG))
#define NM_IP_CONFIG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_IP_CONFIG, NMIPConfigClass))
/**
* NMIPConfig:
*/
struct _NMIPConfig {
NMObject parent;
};
......
......@@ -33,6 +33,9 @@ G_BEGIN_DECLS
#define NM_IS_IP4_CONFIG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_IP4_CONFIG))
#define NM_IP4_CONFIG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_IP4_CONFIG, NMIP4ConfigClass))
/**
* NMIP4Config:
*/
typedef struct {
NMIPConfig parent;
} NMIP4Config;
......
......@@ -33,6 +33,9 @@ G_BEGIN_DECLS
#define NM_IS_IP6_CONFIG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_IP6_CONFIG))
#define NM_IP6_CONFIG_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_IP6_CONFIG, NMIP6ConfigClass))
/**
* NMIP6Config:
*/
typedef struct {
NMIPConfig parent;
} NMIP6Config;
......
......@@ -53,6 +53,9 @@ G_BEGIN_DECLS
#define NM_MANAGER_METERED "metered"
#define NM_MANAGER_ALL_DEVICES "all-devices"
/**
* NMManager:
*/
typedef struct {
NMObject parent;
} NMManager;
......
......@@ -40,6 +40,9 @@ G_BEGIN_DECLS
#define NM_OBJECT_PATH "path"
#define NM_OBJECT_DBUS_CONNECTION "dbus-connection"
/**
* NMObject:
*/
struct _NMObject {
GObject parent;
};
......
......@@ -44,6 +44,9 @@ G_BEGIN_DECLS
#define NM_REMOTE_CONNECTION_UNSAVED "unsaved"
#define NM_REMOTE_CONNECTION_VISIBLE "visible"
/**
* NMRemoteConnection:
*/
struct _NMRemoteConnection {
NMObject parent;
};
......
......@@ -43,6 +43,9 @@ G_BEGIN_DECLS
typedef struct _NMRemoteSettings NMRemoteSettings;
typedef struct _NMRemoteSettingsClass NMRemoteSettingsClass;
/**
* NMRemoteSettings:
*/
struct _NMRemoteSettings {
NMObject parent;
};
......
......@@ -37,6 +37,9 @@ G_BEGIN_DECLS
#define NM_SECRET_AGENT_OLD_REGISTERED "registered"
#define NM_SECRET_AGENT_OLD_CAPABILITIES "capabilities"
/**
* NMSecretAgentOld:
*/
typedef struct {
GObject parent;
} NMSecretAgentOld;
......
......@@ -41,6 +41,9 @@ G_BEGIN_DECLS
#define NM_VPN_CONNECTION_VPN_STATE "vpn-state"
#define NM_VPN_CONNECTION_BANNER "banner"
/**
* NMVpnConnection:
*/
struct _NMVpnConnection {
NMActiveConnection parent;
};
......
......@@ -38,6 +38,9 @@ G_BEGIN_DECLS
#define NM_VPN_PLUGIN_OLD_DBUS_SERVICE_NAME "service-name"
#define NM_VPN_PLUGIN_OLD_STATE "state"
/**
* NMVpnPluginOld:
*/
typedef struct {
NM_DEPRECATED_IN_1_2
GObject parent;
......
......@@ -43,6 +43,9 @@ G_BEGIN_DECLS
#define NM_VPN_SERVICE_PLUGIN_DBUS_WATCH_PEER "watch-peer"
#define NM_VPN_SERVICE_PLUGIN_STATE "state"
/**
* NMVpnServicePlugin:
*/
typedef struct {
NM_AVAILABLE_IN_1_2
GObject parent;
......
......@@ -41,6 +41,9 @@ G_BEGIN_DECLS
#define NM_WIMAX_NSP_SIGNAL_QUALITY "signal-quality"
#define NM_WIMAX_NSP_NETWORK_TYPE "network-type"
/**
* NMWimaxNsp:
*/
struct _NMWimaxNsp {
NMObject 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