dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-ip6-config.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.IP6Config">
5     <property name="Addresses" type="a(ayuay)" access="read">
6       <annotation name="org.gtk.GDBus.DocString" value="
7         Array of tuples of IPv6 address/prefix/gateway.
8
9         Deprecated: use AddressData and Gateway.
10       " />
11     </property>
12     <property name="AddressData" type="aa{sv}" access="read">
13       <annotation name="org.gtk.GDBus.DocString" value="
14         Array of IP address data objects. All addresses will include
15         &quot;address&quot; (an IP address string), and &quot;prefix&quot; (a uint). Some
16         addresses may include additional attributes.
17       " />
18     </property>
19     <property name="Gateway" type="s" access="read">
20       <annotation name="org.gtk.GDBus.DocString" value="The gateway in use." />
21     </property>
22     <property name="Routes" type="a(ayuayu)" access="read">
23       <annotation name="org.gtk.GDBus.DocString" value="
24         Tuples of IPv6 route/prefix/next-hop/metric.
25
26         Deprecated: use RouteData
27       " />
28     </property>
29     <property name="RouteData" type="aa{sv}" access="read">
30       <annotation name="org.gtk.GDBus.DocString" value="
31         Array of IP route data objects. All routes will include &quot;dest&quot;
32         (an IP address string) and &quot;prefix&quot; (a uint). Some routes may
33         include &quot;next-hop&quot; (an IP address string), &quot;metric&quot; (a uint),
34         and additional attributes.
35       " />
36     </property>
37     <property name="Nameservers" type="aay" access="read">
38       <!-- gdbus-codegen assumes that "aay" means "array of non-UTF-8
39            string&quot; and so would make this a char **.
40       -->
41       <annotation name="org.gtk.GDBus.C.ForceGVariant" value="1"/>
42       <annotation name="org.gtk.GDBus.DocString" value="The nameservers in use." />
43     </property>
44     <property name="Domains" type="as" access="read">
45       <annotation name="org.gtk.GDBus.DocString" value="A list of domains this address belongs to." />
46     </property>
47     <property name="Searches" type="as" access="read">
48       <annotation name="org.gtk.GDBus.DocString" value="A list of dns searches." />
49     </property>
50     <property name="DnsOptions" type="as" access="read">
51       <annotation name="org.gtk.GDBus.DocString" value="
52         A list of DNS options that modify the behavior of the DNS
53         resolver. See resolv.conf(5) manual page for the list of
54         supported options.
55       " />
56     </property>
57
58     <signal name="PropertiesChanged">
59       <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
60         <annotation name="org.gtk.GDBus.DocString" value="
61           A dictionary mapping property names to variant boxed values
62         " />
63       </arg>
64     </signal>
65   </interface>
66 </node>
67