dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-active-connection.xml
index 203437b..59bf78f 100644 (file)
@@ -3,12 +3,12 @@
 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   <interface name="org.freedesktop.NetworkManager.Connection.Active">
     <annotation name="org.gtk.GDBus.C.Name" value="ActiveConnection"/>
-    <tp:docstring>
+    <annotation name="org.gtk.GDBus.DocString" value="
       Objects that implement the Connection.Active interface represent an attempt
       to connect to a network using the details provided by a Connection object.
       The Connection.Active object tracks the life-cycle of the connection
       attempt and if successful indicates whether the connected network is the
-      "default" or preferred network for access.
+      &quot;default&quot; or preferred network for access.
       NetworkManager has the concept of connections, which can be thought of as
       settings, a profile or a configuration that can be applied on a networking
       device.
       versa. However, during activation and deactivation multiple active-connections
       can reference the same device or settings-connection as they are waiting to
       be activated or to be deactivated.
-    </tp:docstring>
+    " />
 
     <property name="Connection" type="o" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         The path of the connection.
-      </tp:docstring>
+      " />
     </property>
     <property name="SpecificObject" type="o" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         A specific object associated with the active connection.  This property
         reflects the specific object used during connection activation, and will
         not change over the lifetime of the ActiveConnection once set.
-      </tp:docstring>
+      " />
     </property>
     <property name="Id" type="s" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         The ID of the connection, provided as a convenience so that clients
         do not have to retrieve all connection details.
-      </tp:docstring>
+      " />
     </property>
     <property name="Uuid" type="s" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         The UUID of the connection, provided as a convenience so that clients
         do not have to retrieve all connection details.
-      </tp:docstring>
+      " />
     </property>
     <property name="Type" type="s" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         The type of the connection, provided as a convenience so that clients
         do not have to retrieve all connection details.
-      </tp:docstring>
+      " />
     </property>
     <property name="Devices" type="ao" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         Array of object paths representing devices which are part of this active
         connection.
-      </tp:docstring>
+      " />
     </property>
     <property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         The state of this active connection.
-      </tp:docstring>
+      " />
     </property>
     <property name="Default" type="b" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         Whether this active connection is the default IPv4 connection, i.e.
         whether it currently owns the default IPv4 route.
-      </tp:docstring>
+      " />
     </property>
     <property name="Ip4Config" type="o" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         Object path of the Ip4Config object describing the configuration of the
         connection. Only valid when the connection is in the
         NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
-      </tp:docstring>
+      " />
     </property>
     <property name="Dhcp4Config" type="o" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         Object path of the Dhcp4Config object describing the DHCP options
         returned by the DHCP server (assuming the connection used DHCP). Only
         valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
         state.
-      </tp:docstring>
+      " />
     </property>
     <property name="Default6" type="b" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         Whether this active connection is the default IPv6 connection, i.e.
         whether it currently owns the default IPv6 route.
-      </tp:docstring>
+      " />
     </property>
     <property name="Ip6Config" type="o" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         Object path of the Ip6Config object describing the configuration of the
         connection. Only valid when the connection is in the
         NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
-      </tp:docstring>
+      " />
     </property>
     <property name="Dhcp6Config" type="o" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         Object path of the Dhcp6Config object describing the DHCP options
         returned by the DHCP server (assuming the connection used DHCP). Only
         valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
         state.
-      </tp:docstring>
+      " />
     </property>
     <property name="Vpn" type="b" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         Whether this active connection is also a VPN connection.
-      </tp:docstring>
+      " />
     </property>
     <property name="Master" type="o" access="read">
-      <tp:docstring>
+      <annotation name="org.gtk.GDBus.DocString" value="
         The path to the master device if the connection is a slave.
-      </tp:docstring>
+      " />
     </property>
 
     <signal name="PropertiesChanged">
         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
-            <tp:docstring>
+            <annotation name="org.gtk.GDBus.DocString" value="
                 A dictionary mapping property names to variant boxed values
-            </tp:docstring>
+            " />
         </arg>
     </signal>
 
     <tp:enum name="NM_ACTIVE_CONNECTION_STATE" type="u">
       <tp:enumvalue suffix="UNKNOWN" value="0">
-        <tp:docstring>
+        <annotation name="org.gtk.GDBus.DocString" value="
           The active connection is in an unknown state.
-        </tp:docstring>
+        " />
       </tp:enumvalue>
       <tp:enumvalue suffix="ACTIVATING" value="1">
-        <tp:docstring>
+        <annotation name="org.gtk.GDBus.DocString" value="
           The connection is activating.
-        </tp:docstring>
+        " />
       </tp:enumvalue>
       <tp:enumvalue suffix="ACTIVATED" value="2">
-        <tp:docstring>
+        <annotation name="org.gtk.GDBus.DocString" value="
           The connection is activated.
-        </tp:docstring>
+        " />
       </tp:enumvalue>
       <tp:enumvalue suffix="DEACTIVATING" value="3">
-        <tp:docstring>
+        <annotation name="org.gtk.GDBus.DocString" value="
           The connection is being torn down and cleaned up.
-        </tp:docstring>
+        " />
       </tp:enumvalue>
       <tp:enumvalue suffix="DEACTIVATED" value="4">
-        <tp:docstring>
+        <annotation name="org.gtk.GDBus.DocString" value="
           The connection is no longer active.
-        </tp:docstring>
+        " />
       </tp:enumvalue>
     </tp:enum>
   </interface>