Commit 618373a1 authored by Lubomir Rintel's avatar Lubomir Rintel

dbus: use the annotations for documentation

gdbus only understands those (and gtk docstrings, which we should eventually
use) when generating the documentation.
parent f88dd66e
......@@ -5,87 +5,87 @@
<annotation name="org.gtk.GDBus.C.Name" value="Dispatcher"/>
<method name="Action">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
INTERNAL; not public API. Perform an action.
</tp:docstring>
" />
<arg name="action" type="s" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The action being performed.
</tp:docstring>
" />
</arg>
<arg name="connection" type="a{sa{sv}}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The connection for which this action was triggered.
</tp:docstring>
" />
</arg>
<arg name="connection_properties" type="a{sv}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the connection, including service and path.
</tp:docstring>
" />
</arg>
<arg name="device_properties" type="a{sv}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device, including type, path, interface, and state.
</tp:docstring>
" />
</arg>
<arg name="device_ip4_config" type="a{sv}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's IPv4 configuration.
</tp:docstring>
" />
</arg>
<arg name="device_ip6_config" type="a{sv}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's IPv6 configuration.
</tp:docstring>
" />
</arg>
<arg name="device_dhcp4_config" type="a{sv}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's DHCPv4 configuration.
</tp:docstring>
" />
</arg>
<arg name="device_dhcp6_config" type="a{sv}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's DHCPv6 configuration.
</tp:docstring>
" />
</arg>
<arg name="vpn_ip_iface" type="s" direction="in">
<tp:docstring>VPN interface name.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="VPN interface name." />
</arg>
<arg name="vpn_ip4_config" type="a{sv}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the VPN's IPv4 configuration.
</tp:docstring>
" />
</arg>
<arg name="vpn_ip6_config" type="a{sv}" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the VPN's IPv6 configuration.
</tp:docstring>
" />
</arg>
<arg name="debug" type="b" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Whether to log debug output.
</tp:docstring>
" />
</arg>
<arg name="results" type="a(sus)" direction="out">
<tp:docstring>
<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).
</tp:docstring>
" />
</arg>
</method>
......
......@@ -4,21 +4,21 @@
<tp:copyright>Copyright (C) 2008 Novell, Inc.</tp:copyright>
<tp:error name="Unknown Connection">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Connection was not provided by the settings service.
</tp:docstring>
" />
</tp:error>
<tp:error name="Unknown Device">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Unknown device.
</tp:docstring>
" />
</tp:error>
<tp:error name="Permission Denied">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
User does not have the permission to activate this connection.
</tp:docstring>
" />
</tp:error>
</tp:errors>
<tp:generic-types
xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<tp:mapping name="String_Variant_Map">
<tp:docstring>A mapping from strings to variants representing extra
key-value pairs.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to variants representing extra
key-value pairs." />
<tp:member type="s" name="Key"/>
<tp:member type="v" name="Value"/>
</tp:mapping>
<tp:mapping name="String_String_Map">
<tp:docstring>A mapping from strings to strings representing extra
key-value pairs.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to strings representing extra
key-value pairs." />
<tp:member type="s" name="Key"/>
<tp:member type="s" name="Value"/>
</tp:mapping>
<tp:mapping name="String_String_Variant_Map_Map">
<tp:docstring>A mapping from strings to a map of string to variant.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to a map of string to variant." />
<tp:member type="s" name="Key"/>
<tp:member type="a{sv}" name="Value" tp:type="String_Variant_Map"/>
</tp:mapping>
<tp:enum name="NM_802_11_MODE" type="u">
<tp:docstring></tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="" />
<tp:enumvalue suffix="UNKNOWN" value="0">
<tp:docstring>Mode is unknown.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Mode is unknown." />
</tp:enumvalue>
<tp:enumvalue suffix="ADHOC" value="1">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
For both devices and access point objects, indicates the object is
part of an Ad-Hoc 802.11 network without a central coordinating access
point.
</tp:docstring>
" />
</tp:enumvalue>
<tp:enumvalue suffix="INFRA" value="2">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The wireless device or access point is in infrastructure mode. For
devices, this indicates the device is an 802.11 client/station. For
access point objects, this indicates the object is an access point that
provides connectivity to clients.
</tp:docstring>
" />
</tp:enumvalue>
<tp:enumvalue suffix="AP" value="3">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The device is an access point/hotspot. Not valid for access point
objects themselves.
</tp:docstring>
" />
</tp:enumvalue>
</tp:enum>
</tp:generic-types>
......@@ -3,99 +3,99 @@
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.AccessPoint">
<property name="Flags" type="u" access="read" tp:type="NM_802_11_AP_FLAGS">
<tp:docstring>Flags describing the capabilities of the access point.</tp:docstring>
<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">
<tp:docstring>Flags describing the access point's capabilities according to WPA (Wifi Protected Access).</tp:docstring>
<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">
<tp:docstring>Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol." />
</property>
<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"/>
<tp:docstring>The Service Set Identifier identifying the access point.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="The Service Set Identifier identifying the access point." />
</property>
<property name="Frequency" type="u" access="read">
<tp:docstring>The radio channel frequency in use by the access point, in MHz.</tp:docstring>
<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">
<tp:docstring>The hardware address (BSSID) of the access point.</tp:docstring>
<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">
<tp:docstring>Describes the operating mode of the access point.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Describes the operating mode of the access point." />
</property>
<property name="MaxBitrate" type="u" access="read">
<tp:docstring>The maximum bitrate this access point is capable of, in kilobits/second (Kb/s).</tp:docstring>
<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">
<tp:docstring>The current signal quality of the access point, in percent.</tp:docstring>
<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">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
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.
</tp:docstring>
" />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
</tp:docstring>
" />
</arg>
</signal>
<tp:flags name="NM_802_11_AP_FLAGS" value-prefix="NM_802_11_AP_FLAGS" type="u">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Flags describing the general capabilities of the access point.
</tp:docstring>
" />
<tp:flag suffix="NONE" value="0x0">
<tp:docstring>Null capability - says nothing about the access point.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Null capability - says nothing about the access point." />
</tp:flag>
<tp:flag suffix="PRIVACY" value="0x1">
<tp:docstring>Access point supports privacy measures.</tp:docstring>
<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">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Flags describing the security capabilities of the access point.
</tp:docstring>
" />
<tp:flag suffix="NONE" value="0x0">
<tp:docstring>Null flag.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Null flag." />
</tp:flag>
<tp:flag suffix="PAIR_WEP40" value="0x1">
<tp:docstring>Access point supports pairwise 40-bit WEP encryption.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 40-bit WEP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_WEP104" value="0x2">
<tp:docstring>Access point supports pairwise 104-bit WEP encryption.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 104-bit WEP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_TKIP" value="0x4">
<tp:docstring>Access point supports pairwise TKIP encryption.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise TKIP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_CCMP" value="0x8">
<tp:docstring>Access point supports pairwise CCMP encryption.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise CCMP encryption." />
</tp:flag>
<tp:flag suffix="GROUP_WEP40" value="0x10">
<tp:docstring>Access point supports a group 40-bit WEP cipher.</tp:docstring>
<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">
<tp:docstring>Access point supports a group 104-bit WEP cipher.</tp:docstring>
<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">
<tp:docstring>Access point supports a group TKIP cipher.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Access point supports a group TKIP cipher." />
</tp:flag>
<tp:flag suffix="GROUP_CCMP" value="0x80">
<tp:docstring>Access point supports a group CCMP cipher.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Access point supports a group CCMP cipher." />
</tp:flag>
<tp:flag suffix="KEY_MGMT_PSK" value="0x100">
<tp:docstring>Access point supports PSK key management.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Access point supports PSK key management." />
</tp:flag>
<tp:flag suffix="KEY_MGMT_802_1X" value="0x200">
<tp:docstring>Access point supports 802.1x key management.</tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="Access point supports 802.1x key management." />
</tp:flag>
</tp:flags>
</interface>
......
......@@ -3,12 +3,12 @@
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Connection.Active">
<annotation name="org.gtk.GDBus.C.Name" value="ActiveConnection"/>
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Objects that implement the Connection.Active interface represent an attempt
to connect to a network using the details provided by a Connection object.
The Connection.Active object tracks the life-cycle of the connection
attempt and if successful indicates whether the connected network is the
"default" or preferred network for access.
&quot;default&quot; or preferred network for access.
NetworkManager has the concept of connections, which can be thought of as
settings, a profile or a configuration that can be applied on a networking
device.
......@@ -18,135 +18,135 @@
versa. However, during activation and deactivation multiple active-connections
can reference the same device or settings-connection as they are waiting to
be activated or to be deactivated.
</tp:docstring>
" />
<property name="Connection" type="o" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The path of the connection.
</tp:docstring>
" />
</property>
<property name="SpecificObject" type="o" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
A specific object associated with the active connection. This property
reflects the specific object used during connection activation, and will
not change over the lifetime of the ActiveConnection once set.
</tp:docstring>
" />
</property>
<property name="Id" type="s" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The ID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
</tp:docstring>
" />
</property>
<property name="Uuid" type="s" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The UUID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
</tp:docstring>
" />
</property>
<property name="Type" type="s" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The type of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
</tp:docstring>
" />
</property>
<property name="Devices" type="ao" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Array of object paths representing devices which are part of this active
connection.
</tp:docstring>
" />
</property>
<property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The state of this active connection.
</tp:docstring>
" />
</property>
<property name="Default" type="b" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is the default IPv4 connection, i.e.
whether it currently owns the default IPv4 route.
</tp:docstring>
" />
</property>
<property name="Ip4Config" type="o" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the Ip4Config object describing the configuration of the
connection. Only valid when the connection is in the
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
</tp:docstring>
" />
</property>
<property name="Dhcp4Config" type="o" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the Dhcp4Config object describing the DHCP options
returned by the DHCP server (assuming the connection used DHCP). Only
valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
state.
</tp:docstring>
" />
</property>
<property name="Default6" type="b" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is the default IPv6 connection, i.e.
whether it currently owns the default IPv6 route.
</tp:docstring>
" />
</property>
<property name="Ip6Config" type="o" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the Ip6Config object describing the configuration of the
connection. Only valid when the connection is in the
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
</tp:docstring>
" />
</property>
<property name="Dhcp6Config" type="o" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the Dhcp6Config object describing the DHCP options
returned by the DHCP server (assuming the connection used DHCP). Only
valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
state.
</tp:docstring>
" />
</property>
<property name="Vpn" type="b" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is also a VPN connection.
</tp:docstring>
" />
</property>
<property name="Master" type="o" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The path to the master device if the connection is a slave.
</tp:docstring>
" />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
</tp:docstring>
" />
</arg>
</signal>
<tp:enum name="NM_ACTIVE_CONNECTION_STATE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The active connection is in an unknown state.
</tp:docstring>
" />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATING" value="1">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The connection is activating.
</tp:docstring>
" />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATED" value="2">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The connection is activated.
</tp:docstring>
" />
</tp:enumvalue>
<tp:enumvalue suffix="DEACTIVATING" value="3">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The connection is being torn down and cleaned up.
</tp:docstring>
" />
</tp:enumvalue>
<tp:enumvalue suffix="DEACTIVATED" value="4">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
The connection is no longer active.
</tp:docstring>
" />
</tp:enumvalue>
</tp:enum>
</interface>
......
......@@ -4,45 +4,45 @@
<interface name="org.freedesktop.NetworkManager.AgentManager">
<method name="Register">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Called by secret Agents to register their ability to provide and save
network secrets.
</tp:docstring>
" />
<arg name="identifier" type="s" direction="in">
<tp:docstring>
<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 "[A-Z][a-z][0-9]_-." and the
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).
</tp:docstring>
" />
</arg>
</method>
<method name="RegisterWithCapabilities">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Like Register() but indicates agent capabilities to NetworkManager.
</tp:docstring>
" />
<arg name="identifier" type="s" direction="in">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
See the Register() method's identifier argument.
</tp:docstring>
" />
</arg>
<arg name="capabilities" type="u" direction="in" tp:type="NM_SECRET_AGENT_CAPABILITIES">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Indicates various agent capabilities to NetworkManager.
</tp:docstring>
" />
</arg>
</method>
<method name="Unregister">
<tp:docstring>
<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.
</tp:docstring>
" />
</method>
</interface>
......
......@@ -5,16 +5,16 @@
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
</tp:docstring>
" />
</arg>
</signal>
<property name="Carrier" type="b" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found.
</tp:docstring>
" />
</property>
</interface>
......
......@@ -4,29 +4,29 @@
<interface name="org.freedesktop.NetworkManager.Device.Bond">
<property name="HwAddress" type="s" access="read">
<tp:docstring>
<annotation name="org.gtk.GDBus.DocString" value="