dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-device-tun.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4   <interface name="org.freedesktop.NetworkManager.Device.Tun">
5
6     <property name="Owner" type="x" access="read">
7       <annotation name="org.gtk.GDBus.DocString" value="
8         The uid of the tunnel owner, or -1 if it has no owner.
9       " />
10     </property>
11
12     <property name="Group" type="x" access="read">
13       <annotation name="org.gtk.GDBus.DocString" value="
14         The gid of the tunnel group, or -1 if it has no owner.
15       " />
16     </property>
17
18     <property name="Mode" type="s" access="read">
19       <annotation name="org.gtk.GDBus.DocString" value="
20         The tunnel mode, either &quot;tun&quot; or &quot;tap&quot;.
21       " />
22     </property>
23
24     <property name="NoPi" type="b" access="read">
25       <annotation name="org.gtk.GDBus.DocString" value="
26         The tunnel's &quot;TUN_NO_PI&quot; flag; true if no protocol info is
27         prepended to the tunnel packets.
28       " />
29     </property>
30
31     <property name="VnetHdr" type="b" access="read">
32       <annotation name="org.gtk.GDBus.DocString" value="
33         The tunnel's &quot;TUN_VNET_HDR&quot; flag; true if the tunnel packets
34         include a virtio network header.
35       " />
36     </property>
37
38     <property name="MultiQueue" type="b" access="read">
39       <annotation name="org.gtk.GDBus.DocString" value="
40         The tunnel's &quot;TUN_TAP_MQ&quot; flag; true if callers can connect to
41         the tap device multiple times, for multiple send/receive
42         queues.
43       " />
44     </property>
45
46     <property name="HwAddress" type="s" access="read">
47       <annotation name="org.gtk.GDBus.DocString" value="
48         Hardware address of the device.
49       " />
50     </property>
51
52     <signal name="PropertiesChanged">
53         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
54             <annotation name="org.gtk.GDBus.DocString" value="
55                 A dictionary mapping property names to variant boxed values
56             " />
57         </arg>
58     </signal>
59
60   </interface>
61 </node>