From: Lubomir Rintel Date: Thu, 24 Mar 2016 13:36:14 +0000 (+0100) Subject: dbus: use the annotations for documentation X-Git-Url: https://iam.tj/gitweb/gitweb.cgi?p=NetworkManager.git;a=commitdiff_plain;h=618373a14fd6993bd4317bed01dc48506f6f7d98 dbus: use the annotations for documentation gdbus only understands those (and gtk docstrings, which we should eventually use) when generating the documentation. --- diff --git a/callouts/nm-dispatcher.xml b/callouts/nm-dispatcher.xml index b2c4a21ae..e2e89a89a 100644 --- a/callouts/nm-dispatcher.xml +++ b/callouts/nm-dispatcher.xml @@ -5,87 +5,87 @@ - + - + - + - + - + - + - + - + - + - VPN interface name. + - + - + - + - + diff --git a/introspection/errors.xml b/introspection/errors.xml index f2db86679..34a0a7b96 100644 --- a/introspection/errors.xml +++ b/introspection/errors.xml @@ -4,21 +4,21 @@ Copyright (C) 2008 Novell, Inc. - + - + - + diff --git a/introspection/generic-types.xml b/introspection/generic-types.xml index 681b6662b..2fb680af9 100644 --- a/introspection/generic-types.xml +++ b/introspection/generic-types.xml @@ -1,50 +1,50 @@ - A mapping from strings to variants representing extra - key-value pairs. + - A mapping from strings to strings representing extra - key-value pairs. + - A mapping from strings to a map of string to variant. + - + - Mode is unknown. + - + - + - + diff --git a/introspection/nm-access-point.xml b/introspection/nm-access-point.xml index 16eae0447..603be7132 100644 --- a/introspection/nm-access-point.xml +++ b/introspection/nm-access-point.xml @@ -3,99 +3,99 @@ - Flags describing the capabilities of the access point. + - Flags describing the access point's capabilities according to WPA (Wifi Protected Access). + - Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol. + - The Service Set Identifier identifying the access point. + - The radio channel frequency in use by the access point, in MHz. + - The hardware address (BSSID) of the access point. + - Describes the operating mode of the access point. + - The maximum bitrate this access point is capable of, in kilobits/second (Kb/s). + - The current signal quality of the access point, in percent. + - + - + - + - Null capability - says nothing about the access point. + - Access point supports privacy measures. + - + - Null flag. + - Access point supports pairwise 40-bit WEP encryption. + - Access point supports pairwise 104-bit WEP encryption. + - Access point supports pairwise TKIP encryption. + - Access point supports pairwise CCMP encryption. + - Access point supports a group 40-bit WEP cipher. + - Access point supports a group 104-bit WEP cipher. + - Access point supports a group TKIP cipher. + - Access point supports a group CCMP cipher. + - Access point supports PSK key management. + - Access point supports 802.1x key management. + diff --git a/introspection/nm-active-connection.xml b/introspection/nm-active-connection.xml index 203437b7c..59bf78f4d 100644 --- a/introspection/nm-active-connection.xml +++ b/introspection/nm-active-connection.xml @@ -3,12 +3,12 @@ - + + " /> - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-agent-manager.xml b/introspection/nm-agent-manager.xml index 4b53675cf..52460eeee 100644 --- a/introspection/nm-agent-manager.xml +++ b/introspection/nm-agent-manager.xml @@ -4,45 +4,45 @@ - + - + + " /> - + - + - + - + diff --git a/introspection/nm-device-adsl.xml b/introspection/nm-device-adsl.xml index ec50d1104..68859d3be 100644 --- a/introspection/nm-device-adsl.xml +++ b/introspection/nm-device-adsl.xml @@ -5,16 +5,16 @@ - + - + diff --git a/introspection/nm-device-bond.xml b/introspection/nm-device-bond.xml index a804ca0b6..9bc21225a 100644 --- a/introspection/nm-device-bond.xml +++ b/introspection/nm-device-bond.xml @@ -4,29 +4,29 @@ - + - + - + - + diff --git a/introspection/nm-device-bridge.xml b/introspection/nm-device-bridge.xml index f3b25602f..6cf99a10c 100644 --- a/introspection/nm-device-bridge.xml +++ b/introspection/nm-device-bridge.xml @@ -4,29 +4,29 @@ - + - + - + - + diff --git a/introspection/nm-device-bt.xml b/introspection/nm-device-bt.xml index cc4a9b544..3b487158e 100644 --- a/introspection/nm-device-bt.xml +++ b/introspection/nm-device-bt.xml @@ -4,43 +4,43 @@ - + - + - + - + - + - The device has no recognized capabilities. + - The device supports Bluetooth Dial-Up Networking. + - The device supports Bluetooth Personal Area Networking. + diff --git a/introspection/nm-device-ethernet.xml b/introspection/nm-device-ethernet.xml index 86d68a35a..87b7f755d 100644 --- a/introspection/nm-device-ethernet.xml +++ b/introspection/nm-device-ethernet.xml @@ -5,40 +5,40 @@ - + - + - + - + - + - + diff --git a/introspection/nm-device-generic.xml b/introspection/nm-device-generic.xml index 79d198996..2f8fc7eea 100644 --- a/introspection/nm-device-generic.xml +++ b/introspection/nm-device-generic.xml @@ -4,22 +4,22 @@ - + - + - + diff --git a/introspection/nm-device-infiniband.xml b/introspection/nm-device-infiniband.xml index 097714c69..169c2c66c 100644 --- a/introspection/nm-device-infiniband.xml +++ b/introspection/nm-device-infiniband.xml @@ -4,22 +4,22 @@ - + - + - + diff --git a/introspection/nm-device-ip-tunnel.xml b/introspection/nm-device-ip-tunnel.xml index fcb42ce27..3ca04ee66 100644 --- a/introspection/nm-device-ip-tunnel.xml +++ b/introspection/nm-device-ip-tunnel.xml @@ -4,81 +4,81 @@ - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-device-macvlan.xml b/introspection/nm-device-macvlan.xml index c4dcb4e60..d5d66068d 100644 --- a/introspection/nm-device-macvlan.xml +++ b/introspection/nm-device-macvlan.xml @@ -4,34 +4,34 @@ - + - - The macvlan mode, one of "private", "vepa", "bridge", or "passthru". - + - + - + - + diff --git a/introspection/nm-device-modem.xml b/introspection/nm-device-modem.xml index 0ca101fd7..67742c463 100644 --- a/introspection/nm-device-modem.xml +++ b/introspection/nm-device-modem.xml @@ -5,58 +5,58 @@ - + - + - + - + - Modem has no capabilties. + - + - + - + - + diff --git a/introspection/nm-device-olpc-mesh.xml b/introspection/nm-device-olpc-mesh.xml index c30ecfc60..a92e73709 100644 --- a/introspection/nm-device-olpc-mesh.xml +++ b/introspection/nm-device-olpc-mesh.xml @@ -3,32 +3,32 @@ - + - + - + - + - + diff --git a/introspection/nm-device-team.xml b/introspection/nm-device-team.xml index baf39fa86..982b76701 100644 --- a/introspection/nm-device-team.xml +++ b/introspection/nm-device-team.xml @@ -4,29 +4,29 @@ - + - + - + - + diff --git a/introspection/nm-device-tun.xml b/introspection/nm-device-tun.xml index 2b3ae2f52..0f74cf8c4 100644 --- a/introspection/nm-device-tun.xml +++ b/introspection/nm-device-tun.xml @@ -4,56 +4,56 @@ - + - + - - The tunnel mode, either "tun" or "tap". - + - - The tunnel's "TUN_NO_PI" flag; true if no protocol info is + - - The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets + - - The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to + - + - + diff --git a/introspection/nm-device-veth.xml b/introspection/nm-device-veth.xml index e06d0ceb7..a3cff6da0 100644 --- a/introspection/nm-device-veth.xml +++ b/introspection/nm-device-veth.xml @@ -4,16 +4,16 @@ - + - + diff --git a/introspection/nm-device-vlan.xml b/introspection/nm-device-vlan.xml index 992340e00..bac220e89 100644 --- a/introspection/nm-device-vlan.xml +++ b/introspection/nm-device-vlan.xml @@ -4,34 +4,34 @@ - + - + - + - + - + diff --git a/introspection/nm-device-vxlan.xml b/introspection/nm-device-vxlan.xml index 97c517fb7..de23020d5 100644 --- a/introspection/nm-device-vxlan.xml +++ b/introspection/nm-device-vxlan.xml @@ -4,123 +4,123 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-device-wifi.xml b/introspection/nm-device-wifi.xml index 27f3eb906..2ece0ef0a 100644 --- a/introspection/nm-device-wifi.xml +++ b/introspection/nm-device-wifi.xml @@ -6,164 +6,164 @@ - + - + - + - + - + + Currently 'ssids' option with value of "aay" type is supported. + " /> - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities! + - The device supports the 40-bit WEP cipher. + - The device supports the 104-bit WEP cipher. + - The device supports the TKIP cipher. + - The device supports the CCMP cipher. + - The device supports the WPA encryption/authentication protocol. + - The device supports the RSN encryption/authentication protocol. + - The device supports Access Point mode. + - The device supports Ad-Hoc mode. + - + - + - + diff --git a/introspection/nm-device-wimax.xml b/introspection/nm-device-wimax.xml index 3bad62453..e790e4fc6 100644 --- a/introspection/nm-device-wimax.xml +++ b/introspection/nm-device-wimax.xml @@ -4,105 +4,105 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-device.xml b/introspection/nm-device.xml index f1033c73f..321cace13 100644 --- a/introspection/nm-device.xml +++ b/introspection/nm-device.xml @@ -3,7 +3,7 @@ - + - + - + - + - + - + - + - + - + - + - - Object path of an ActiveConnection object that "owns" this device during + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - Unused + - Unused + - + - + - + - + - + - + - + - + - + - + - + - Null capability. + - The device is supported by NetworkManager. + - The device supports carrier detection. + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-dhcp4-config.xml b/introspection/nm-dhcp4-config.xml index 379c50f9b..bca34fc53 100644 --- a/introspection/nm-dhcp4-config.xml +++ b/introspection/nm-dhcp4-config.xml @@ -3,18 +3,18 @@ - + - Configuration options returned by a DHCP server, if any. + - + diff --git a/introspection/nm-dhcp6-config.xml b/introspection/nm-dhcp6-config.xml index df75660a7..84e13b77b 100644 --- a/introspection/nm-dhcp6-config.xml +++ b/introspection/nm-dhcp6-config.xml @@ -3,18 +3,18 @@ - + - Configuration options returned by a DHCP server, if any. + - + diff --git a/introspection/nm-ip4-config.xml b/introspection/nm-ip4-config.xml index 5a9e8ea1c..111e1acf7 100644 --- a/introspection/nm-ip4-config.xml +++ b/introspection/nm-ip4-config.xml @@ -3,26 +3,26 @@ - + - + + " /> - The gateway in use. + - + - - Array of IP route data objects. All routes will include "dest" - (an IP address string) and "prefix" (a uint). Some routes may - include "next-hop" (an IP address string), "metric" (a uint), + - The nameservers in use. + - A list of domains this address belongs to. + - A list of dns searches. + - + - The Windows Internet Name Service servers associated with the connection. Each address is in network byte order. + - + diff --git a/introspection/nm-ip6-config.xml b/introspection/nm-ip6-config.xml index 1a107bf29..0cca33c4f 100644 --- a/introspection/nm-ip6-config.xml +++ b/introspection/nm-ip6-config.xml @@ -3,63 +3,63 @@ - + - + + " /> - The gateway in use. + - + - - Array of IP route data objects. All routes will include "dest" - (an IP address string) and "prefix" (a uint). Some routes may - include "next-hop" (an IP address string), "metric" (a uint), + - The nameservers in use. + - A list of domains this address belongs to. + - A list of dns searches. + - + - + diff --git a/introspection/nm-manager.xml b/introspection/nm-manager.xml index dd6fc4bdd..8203020b3 100644 --- a/introspection/nm-manager.xml +++ b/introspection/nm-manager.xml @@ -5,213 +5,213 @@ - + - + - + - + - + - + - + - + - - The connection to activate. If "/" is given, a valid device path must + - + - + + "base" connection (to which the VPN connections lifetime will be tied), + or pass "/" and NM will automatically use the current default device. + " /> - + - + - + - + - + + " /> - + - + - + - + - + - + - + - + - + - + + " /> - + - + - + + " /> - - A combination of logging domains separated by commas (','), or "NONE" + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - The object path of the "primary" active connection being used + - - The connection type of the "primary" active connection being + - + - + - + - + - + - + - + - + - + + third-level dictionary with the keys "servers" and + "options". "servers" is a string array of DNS servers, + "options" is a string array of domain-specific options. + " /> - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-secret-agent.xml b/introspection/nm-secret-agent.xml index 337d0a7fa..ec7ede091 100644 --- a/introspection/nm-secret-agent.xml +++ b/introspection/nm-secret-agent.xml @@ -3,20 +3,20 @@ - + + " /> - + - + - + - + - + + "x-vpn-message:". + " /> - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - No special capabilities. + - + diff --git a/introspection/nm-settings-connection.xml b/introspection/nm-settings-connection.xml index 2d919619f..fc62046c8 100644 --- a/introspection/nm-settings-connection.xml +++ b/introspection/nm-settings-connection.xml @@ -3,27 +3,27 @@ - + - + - + - + - + - + - + - + - + - + - + - + - - Saves a "dirty" connection (that had previously been + - + - + - + - + diff --git a/introspection/nm-settings.xml b/introspection/nm-settings.xml index b6ab8260e..628920251 100644 --- a/introspection/nm-settings.xml +++ b/introspection/nm-settings.xml @@ -2,58 +2,58 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + + " /> - + - + - + - + + "monitor-connection-files=false" in NetworkManager.conf. + " /> - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-vpn-connection.xml b/introspection/nm-vpn-connection.xml index 03bbbe980..6a4fb37db 100644 --- a/introspection/nm-vpn-connection.xml +++ b/introspection/nm-vpn-connection.xml @@ -4,143 +4,143 @@ - + - + - The VPN-specific state of the connection. + - The banner string of the VPN connection. + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-vpn-plugin.xml b/introspection/nm-vpn-plugin.xml index adb6a0852..ee8c69f8b 100644 --- a/introspection/nm-vpn-plugin.xml +++ b/introspection/nm-vpn-plugin.xml @@ -4,20 +4,20 @@ - + - + - + @@ -30,22 +30,22 @@ - + - + - + @@ -59,19 +59,19 @@ - + - + - + @@ -79,9 +79,9 @@ - + @@ -90,105 +90,105 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -199,113 +199,113 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/introspection/nm-wimax-nsp.xml b/introspection/nm-wimax-nsp.xml index 55ac4abcf..6174ad673 100644 --- a/introspection/nm-wimax-nsp.xml +++ b/introspection/nm-wimax-nsp.xml @@ -4,38 +4,38 @@ - The name of the NSP. + - The current signal quality of the NSP, in percent. + - The network type of the NSP. + - + - + - Unknown network. + - Home network. + - Partner network. + - Roaming partner network. + diff --git a/introspection/vpn-errors.xml b/introspection/vpn-errors.xml index 7b92d0736..c1e02aacb 100644 --- a/introspection/vpn-errors.xml +++ b/introspection/vpn-errors.xml @@ -2,59 +2,59 @@ - General failure without further details. + - + - + - + - + - + - + - + - + - + diff --git a/src/settings/plugins/ifcfg-rh/nm-ifcfg-rh.xml b/src/settings/plugins/ifcfg-rh/nm-ifcfg-rh.xml index 1f308dd48..c2a6cb34e 100644 --- a/src/settings/plugins/ifcfg-rh/nm-ifcfg-rh.xml +++ b/src/settings/plugins/ifcfg-rh/nm-ifcfg-rh.xml @@ -2,28 +2,28 @@ - + - + - + - + - +