NetworkManager/introspection/nm-device-tun.xml
Lubomir Rintel 618373a14f dbus: use the annotations for documentation
gdbus only understands those (and gtk docstrings, which we should eventually
use) when generating the documentation.
2016-03-26 11:28:19 +01:00

61 lines
2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Device.Tun">
<property name="Owner" type="x" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The uid of the tunnel owner, or -1 if it has no owner.
" />
</property>
<property name="Group" type="x" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The gid of the tunnel group, or -1 if it has no owner.
" />
</property>
<property name="Mode" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The tunnel mode, either &quot;tun&quot; or &quot;tap&quot;.
" />
</property>
<property name="NoPi" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The tunnel's &quot;TUN_NO_PI&quot; flag; true if no protocol info is
prepended to the tunnel packets.
" />
</property>
<property name="VnetHdr" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The tunnel's &quot;TUN_VNET_HDR&quot; flag; true if the tunnel packets
include a virtio network header.
" />
</property>
<property name="MultiQueue" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The tunnel's &quot;TUN_TAP_MQ&quot; flag; true if callers can connect to
the tap device multiple times, for multiple send/receive
queues.
" />
</property>
<property name="HwAddress" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
" />
</property>
<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>
</signal>
</interface>
</node>