Commit 6e2b1883 authored by Lubomir Rintel's avatar Lubomir Rintel

dbus: convert the annotations to gtk-doc blocks

parent 5c5fd96d
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
<interface name="org.freedesktop.nm_dispatcher">
<annotation name="org.gtk.GDBus.C.Name" value="Dispatcher"/>
<!--
Action:
@action: The action being performed.
@connection: The connection for which this action was triggered.
@connection_properties: Properties of the connection, including service and path.
@device_properties: Properties of the device, including type, path, interface, and state.
@device_ip4_config: Properties of the device's IPv4 configuration.
@device_ip6_config: Properties of the device's IPv6 configuration.
@device_dhcp4_config: Properties of the device's DHCPv4 configuration.
@device_dhcp6_config: Properties of the device's DHCPv6 configuration.
@vpn_ip_iface: VPN interface name.
@vpn_ip4_config: Properties of the VPN's IPv4 configuration.
@vpn_ip6_config: Properties of the VPN's IPv6 configuration.
@debug: Whether to log debug output.
@results: Results of dispatching operations. Each element of the returned array is a struct containing the path of an executed script (s), the result of running that script (u), and a description of the result (s).
INTERNAL; not public API. Perform an action.
-->
<method name="Action">
<annotation name="org.gtk.GDBus.DocString" value="
INTERNAL; not public API. Perform an action.
" />
<arg name="action" type="s" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
The action being performed.
" />
</arg>
<arg name="action" type="s" direction="in"/>
<arg name="connection" type="a{sa{sv}}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
The connection for which this action was triggered.
" />
</arg>
<arg name="connection" type="a{sa{sv}}" direction="in"/>
<arg name="connection_properties" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the connection, including service and path.
" />
</arg>
<arg name="connection_properties" type="a{sv}" direction="in"/>
<arg name="device_properties" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device, including type, path, interface, and state.
" />
</arg>
<arg name="device_properties" type="a{sv}" direction="in"/>
<arg name="device_ip4_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's IPv4 configuration.
" />
</arg>
<arg name="device_ip4_config" type="a{sv}" direction="in"/>
<arg name="device_ip6_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's IPv6 configuration.
" />
</arg>
<arg name="device_ip6_config" type="a{sv}" direction="in"/>
<arg name="device_dhcp4_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's DHCPv4 configuration.
" />
</arg>
<arg name="device_dhcp4_config" type="a{sv}" direction="in"/>
<arg name="device_dhcp6_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's DHCPv6 configuration.
" />
</arg>
<arg name="device_dhcp6_config" type="a{sv}" direction="in"/>
<arg name="vpn_ip_iface" type="s" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="VPN interface name." />
</arg>
<arg name="vpn_ip_iface" type="s" direction="in"/>
<arg name="vpn_ip4_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the VPN's IPv4 configuration.
" />
</arg>
<arg name="vpn_ip4_config" type="a{sv}" direction="in"/>
<arg name="vpn_ip6_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the VPN's IPv6 configuration.
" />
</arg>
<arg name="vpn_ip6_config" type="a{sv}" direction="in"/>
<arg name="debug" type="b" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Whether to log debug output.
" />
</arg>
<arg name="debug" type="b" direction="in"/>
<arg name="results" type="a(sus)" direction="out">
<annotation name="org.gtk.GDBus.DocString" value="
Results of dispatching operations. Each element of the returned
array is a struct containing the path of an executed script (s),
the result of running that script (u), and a description of the
result (s).
" />
</arg>
<arg name="results" type="a(sus)" direction="out"/>
</method>
</interface>
......
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
<interface name="org.freedesktop.NetworkManager.AccessPoint">
<property name="Flags" type="u" access="read" tp:type="NM_802_11_AP_FLAGS">
<annotation name="org.gtk.GDBus.DocString" value="Flags describing the capabilities of the access point." />
</property>
<property name="WpaFlags" type="u" access="read" tp:type="NM_802_11_AP_SEC">
<annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to WPA (Wifi Protected Access)." />
</property>
<property name="RsnFlags" type="u" access="read" tp:type="NM_802_11_AP_SEC">
<annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol." />
</property>
<!--
Flags:
Flags describing the capabilities of the access point.
Returns: #NM80211ApFlags
-->
<property name="Flags" type="u" access="read"/>
<!--
WpaFlags:
Flags describing the access point's capabilities according to WPA (Wifi
Protected Access).
Returns: #NM80211ApSecurityFlags
-->
<property name="WpaFlags" type="u" access="read"/>
<!--
RsnFlags:
Flags describing the access point's capabilities according to the RSN
(Robust Secure Network) protocol.
Returns: #NM80211ApSecurityFlags
-->
<property name="RsnFlags" type="u" access="read"/>
<!--
Ssid:
The Service Set Identifier identifying the access point.
-->
<property name="Ssid" type="ay" access="read">
<!-- gdbus-codegen assumes that "ay" means "non-UTF-8 string" and
won't deal with '\0' bytes correctly.
-->
<annotation name="org.gtk.GDBus.C.ForceGVariant" value="1"/>
<annotation name="org.gtk.GDBus.DocString" value="The Service Set Identifier identifying the access point." />
</property>
<property name="Frequency" type="u" access="read">
<annotation name="org.gtk.GDBus.DocString" value="The radio channel frequency in use by the access point, in MHz." />
</property>
<property name="HwAddress" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="The hardware address (BSSID) of the access point." />
</property>
<property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE">
<annotation name="org.gtk.GDBus.DocString" value="Describes the operating mode of the access point." />
</property>
<property name="MaxBitrate" type="u" access="read">
<annotation name="org.gtk.GDBus.DocString" value="The maximum bitrate this access point is capable of, in kilobits/second (Kb/s)." />
</property>
<property name="Strength" type="y" access="read">
<annotation name="org.gtk.GDBus.DocString" value="The current signal quality of the access point, in percent." />
</property>
<property name="LastSeen" type="i" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
</property>
<!--
Frequency:
The radio channel frequency in use by the access point, in MHz.
-->
<property name="Frequency" type="u" access="read"/>
<!--
HwAddress:
The hardware address (BSSID) of the access point.
-->
<property name="HwAddress" type="s" access="read"/>
<!--
Mode:
Describes the operating mode of the access point.
Returns: #NM80211Mode
-->
<property name="Mode" type="u" access="read"/>
<!--
MaxBitrate:
The maximum bitrate this access point is capable of, in kilobits/second
(Kb/s).
-->
<property name="MaxBitrate" type="u" access="read"/>
<!--
Strength:
The current signal quality of the access point, in percent.
-->
<property name="Strength" type="y" access="read"/>
<!--
LastSeen:
The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access
point was found in scan results. A value of -1 means the access point
has never been found in scan results.
" />
</property>
point was found in scan results. A value of -1 means the access point has
never been found in scan results.
-->
<property name="LastSeen" type="i" access="read"/>
<!--
PropertiesChanged:
@properties: A dictionary mapping property names to variant boxed values
-->
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
" />
</arg>
<arg name="properties" type="a{sv}"/>
</signal>
<tp:flags name="NM_802_11_AP_FLAGS" value-prefix="NM_802_11_AP_FLAGS" type="u">
<annotation name="org.gtk.GDBus.DocString" value="
Flags describing the general capabilities of the access point.
" />
<tp:flag suffix="NONE" value="0x0">
<annotation name="org.gtk.GDBus.DocString" value="Null capability - says nothing about the access point." />
</tp:flag>
<tp:flag suffix="PRIVACY" value="0x1">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports privacy measures." />
</tp:flag>
</tp:flags>
<tp:flags name="NM_802_11_AP_SEC" value-prefix="NM_802_11_AP_SEC" type="u">
<annotation name="org.gtk.GDBus.DocString" value="
Flags describing the security capabilities of the access point.
" />
<tp:flag suffix="NONE" value="0x0">
<annotation name="org.gtk.GDBus.DocString" value="Null flag." />
</tp:flag>
<tp:flag suffix="PAIR_WEP40" value="0x1">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 40-bit WEP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_WEP104" value="0x2">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 104-bit WEP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_TKIP" value="0x4">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise TKIP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_CCMP" value="0x8">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise CCMP encryption." />
</tp:flag>
<tp:flag suffix="GROUP_WEP40" value="0x10">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports a group 40-bit WEP cipher." />
</tp:flag>
<tp:flag suffix="GROUP_WEP104" value="0x20">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports a group 104-bit WEP cipher." />
</tp:flag>
<tp:flag suffix="GROUP_TKIP" value="0x40">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports a group TKIP cipher." />
</tp:flag>
<tp:flag suffix="GROUP_CCMP" value="0x80">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports a group CCMP cipher." />
</tp:flag>
<tp:flag suffix="KEY_MGMT_PSK" value="0x100">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports PSK key management." />
</tp:flag>
<tp:flag suffix="KEY_MGMT_802_1X" value="0x200">
<annotation name="org.gtk.GDBus.DocString" value="Access point supports 802.1x key management." />
</tp:flag>
</tp:flags>
</interface>
</node>
This diff is collapsed.
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/org/freedesktop/NetworkManager/AgentManager" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<?xml version="1.0" encoding="UTF-8"?>
<node name="/org/freedesktop/NetworkManager/AgentManager">
<interface name="org.freedesktop.NetworkManager.AgentManager">
<method name="Register">
<annotation name="org.gtk.GDBus.DocString" value="
<!--
Register:
@identifier: Identifies this agent; only one agent in each user session may use the same identifier. Identifier formatting follows the same rules as D-Bus bus names with the exception that the ':' character is not allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the identifier is limited in length to 255 characters with a minimum of 3 characters. An example valid identifier is 'org.gnome.nm-applet' (without quotes).
Called by secret Agents to register their ability to provide and save
network secrets.
" />
<arg name="identifier" type="s" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Identifies this agent; only one agent in each user session may use the
same identifier. Identifier formatting follows the same rules as
D-Bus bus names with the exception that the ':' character is not
allowed. The valid set of characters is &quot;[A-Z][a-z][0-9]_-.&quot; and the
identifier is limited in length to 255 characters with a minimum
of 3 characters. An example valid identifier is 'org.gnome.nm-applet'
(without quotes).
" />
</arg>
-->
<method name="Register">
<arg name="identifier" type="s" direction="in"/>
</method>
<method name="RegisterWithCapabilities">
<annotation name="org.gtk.GDBus.DocString" value="
<!--
RegisterWithCapabilities:
@identifier: See the Register() method's identifier argument.
@capabilities: (#NMSecretAgentCapabilities) Indicates various agent capabilities to NetworkManager.
Like Register() but indicates agent capabilities to NetworkManager.
" />
<arg name="identifier" type="s" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
See the Register() method's identifier argument.
" />
</arg>
<arg name="capabilities" type="u" direction="in" tp:type="NM_SECRET_AGENT_CAPABILITIES">
<annotation name="org.gtk.GDBus.DocString" value="
Indicates various agent capabilities to NetworkManager.
" />
</arg>
-->
<method name="RegisterWithCapabilities">
<arg name="identifier" type="s" direction="in"/>
<arg name="capabilities" type="u" direction="in"/>
</method>
<method name="Unregister">
<annotation name="org.gtk.GDBus.DocString" value="
Called by secret Agents to notify NetworkManager that they will no
longer handle requests for network secrets. Agents are automatically
unregistered when they disconnect from D-Bus.
" />
</method>
<!--
Unregister:
Called by secret Agents to notify NetworkManager that they will no longer
handle requests for network secrets. Agents are automatically unregistered
when they disconnect from D-Bus.
-->
<method name="Unregister"/>
</interface>
</node>
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
<interface name="org.freedesktop.NetworkManager.Device.Adsl">
<!--
PropertiesChanged:
@properties: A dictionary mapping property names to variant boxed values
-->
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
" />
</arg>
<arg name="properties" type="a{sv}"/>
</signal>
<property name="Carrier" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
<!--
Carrier:
Indicates whether the physical carrier is found.
" />
</property>
-->
<property name="Carrier" type="b" access="read"/>
</interface>
</node>
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
<interface name="org.freedesktop.NetworkManager.Device.Bond">
<property name="HwAddress" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
<!--
HwAddress:
Hardware address of the device.
" />
</property>
<property name="Carrier" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
" />
</property>
<property name="Slaves" type="ao" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Array of object paths representing devices which are currently
slaved to this device.
" />
</property>
-->
<property name="HwAddress" type="s" access="read"/>
<!--
Carrier:
Indicates whether the physical carrier is found (e.g. whether a cable is
plugged in or not).
-->
<property name="Carrier" type="b" access="read"/>
<!--
Slaves:
Array of object paths representing devices which are currently slaved to
this device.
-->
<property name="Slaves" type="ao" access="read"/>
<!--
PropertiesChanged:
@properties: A dictionary mapping property names to variant boxed values
-->
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
" />
</arg>
<arg name="properties" type="a{sv}"/>
</signal>
</interface>
......
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
<interface name="org.freedesktop.NetworkManager.Device.Bridge">
<property name="HwAddress" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
<!--
HwAddress:
Hardware address of the device.
" />
</property>
<property name="Carrier" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
" />
</property>
<property name="Slaves" type="ao" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Array of object paths representing devices which are currently
slaved to this device.
" />
</property>
-->
<property name="HwAddress" type="s" access="read"/>
<!--
Carrier:
Indicates whether the physical carrier is found (e.g. whether a cable is
plugged in or not).
-->
<property name="Carrier" type="b" access="read"/>
<!--
Slaves:
Array of object paths representing devices which are currently slaved to
this device.
-->
<property name="Slaves" type="ao" access="read"/>
<!--
PropertiesChanged:
@properties: A dictionary mapping property names to variant boxed values
-->
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
" />
</arg>
<arg name="properties" type="a{sv}"/>
</signal>
</interface>
......
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
<interface name="org.freedesktop.NetworkManager.Device.Bluetooth">
<property name="HwAddress" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
<!--
HwAddress:
Bluetooth hardware address of the device.
" />
</property>
-->
<property name="HwAddress" type="s" access="read"/>
<!--
Name:
<property name="Name" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Bluetooth name of the device.
" />
</property>
-->
<property name="Name" type="s" access="read"/>
<!--
BtCapabilities:
<property name="BtCapabilities" type="u" access="read" tp:type="NM_BT_CAPABILITIES">
<annotation name="org.gtk.GDBus.DocString" value="
Bluetooth capabilities of the device (either DUN or NAP).
" />
</property>
Returns: #NMBluetoothCapabilities
-->
<property name="BtCapabilities" type="u" access="read"/>
<!--
PropertiesChanged:
@properties: A dictionary mapping property names to variant boxed values
-->
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
" />
</arg>
<arg name="properties" type="a{sv}"/>
</signal>
<tp:flags name="NM_BT_CAPABILITIES" value-prefix="NM_BT_CAPABILITY" type="u">
<annotation name="org.gtk.GDBus.DocString" value="
Flags describing the capabilities of a Bluetooth device.
" />
<tp:flag suffix="NONE" value="0x0">
<annotation name="org.gtk.GDBus.DocString" value="The device has no recognized capabilities." />
</tp:flag>
<tp:flag suffix="DUN" value="0x1">
<annotation name="org.gtk.GDBus.DocString" value="The device supports Bluetooth Dial-Up Networking." />
</tp:flag>
<tp:flag suffix="PAN" value="0x2">
<annotation name="org.gtk.GDBus.DocString" value="The device supports Bluetooth Personal Area Networking." />
</tp:flag>
</tp:flags>
</interface>
</node>
<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
<interface name="org.freedesktop.NetworkManager.Device.Wired">