summaryrefslogtreecommitdiff
path: root/callouts
diff options
context:
space:
mode:
authorLubomir Rintel <lkundrak@v3.sk>2016-04-05 01:09:48 +0200
committerLubomir Rintel <lkundrak@v3.sk>2016-04-05 14:37:51 +0200
commit6e2b1883611b024527d7e8802cad0dac8ee43506 (patch)
tree74adb832b805c3b71bd0629bf30207db0553986a /callouts
parent5c5fd96d2b5f2daa9cdc7ef6d75773c4d7507a9f (diff)
downloadNetworkManager-6e2b1883611b024527d7e8802cad0dac8ee43506.tar.gz
dbus: convert the annotations to gtk-doc blocks
Diffstat (limited to 'callouts')
-rw-r--r--callouts/nm-dispatcher.xml106
1 files changed, 33 insertions, 73 deletions
diff --git a/callouts/nm-dispatcher.xml b/callouts/nm-dispatcher.xml
index e2e89a89ad..383374de3d 100644
--- a/callouts/nm-dispatcher.xml
+++ b/callouts/nm-dispatcher.xml
@@ -1,92 +1,52 @@
-<?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>