dbus: use the annotations for documentation
[NetworkManager.git] / src / settings / plugins / ifcfg-rh / nm-ifcfg-rh.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="com.redhat.ifcfgrh1">
5       <annotation name="org.gtk.GDBus.DocString" value="
6           Utility methods for handling NM integration with standard Red Hat ifcfg files.
7       " />
8
9       <method name="GetIfcfgDetails">
10         <annotation name="org.gtk.GDBus.DocString" value="
11           Given an ifcfg file, return various internal information about it.
12         " />
13         <arg name="ifcfg" type="s" direction="in">
14           <annotation name="org.gtk.GDBus.DocString" value="
15             The full path to an ifcfg file.
16           " />
17         </arg>
18         <arg name="uuid" type="s" direction="out">
19           <annotation name="org.gtk.GDBus.DocString" value="
20             The UUID of the NM connection backed by this ifcfg file.  If the ifcfg file does not contain a UUID tag, this UUID is generated by NM, otherwise the UUID from the ifcfg file is used.
21           " />
22         </arg>
23         <arg name="path" type="o" direction="out">
24           <annotation name="org.gtk.GDBus.DocString" value="
25             The object path of the NM connected backed by this ifcfg file.
26           " />
27         </arg>
28       </method>
29     </interface>
30 </node>