dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-device-modem.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.Modem">
5
6     <signal name="PropertiesChanged">
7         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
8             <annotation name="org.gtk.GDBus.DocString" value="
9                 A dictionary mapping property names to variant boxed values
10             " />
11         </arg>
12     </signal>
13
14     <property name="ModemCapabilities" type="u" access="read" tp:type="NM_DEVICE_MODEM_CAPABILITIES">
15       <annotation name="org.gtk.GDBus.DocString" value="
16         The generic family of access technologies the modem supports.  Not all
17         capabilities are available at the same time however; some modems require
18         a firmware reload or other reinitialization to switch between eg CDMA/EVDO
19         and GSM/UMTS.
20       " />
21     </property>
22
23     <property name="CurrentCapabilities" type="u" access="read" tp:type="NM_DEVICE_MODEM_CAPABILITIES">
24       <annotation name="org.gtk.GDBus.DocString" value="
25         The generic family of access technologies the modem currently supports
26         without a firmware reload or reinitialization.
27       " />
28     </property>
29
30     <tp:flags name="NM_DEVICE_MODEM_CAPABILITIES" value-prefix="NM_DEVICE_MODEM_CAPABILITY" type="u">
31       <annotation name="org.gtk.GDBus.DocString" value="
32         Flags describing one or more of the general access technology families
33         that a modem device supports.
34       " />
35       <tp:flag suffix="NONE" value="0x0">
36         <annotation name="org.gtk.GDBus.DocString" value="Modem has no capabilties." />
37       </tp:flag>
38       <tp:flag suffix="POTS" value="0x1">
39         <annotation name="org.gtk.GDBus.DocString" value="
40           Modem supports the analog wired telephone network (ie 56k dialup) and
41           does not have wireless/cellular capabilities.
42         " />
43       </tp:flag>
44       <tp:flag suffix="CDMA_EVDO" value="0x2">
45         <annotation name="org.gtk.GDBus.DocString" value="
46           Modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO
47           revision A, or EVDO revision B.
48         " />
49       </tp:flag>
50       <tp:flag suffix="GSM_UMTS" value="0x4">
51         <annotation name="org.gtk.GDBus.DocString" value="
52           Modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or
53           HSPA+ packet switched data capability.
54         " />
55       </tp:flag>
56       <tp:flag suffix="LTE" value="0x8">
57         <annotation name="org.gtk.GDBus.DocString" value="
58           Modem has at LTE data capability.
59         " />
60       </tp:flag>
61     </tp:flags>
62
63   </interface>
64 </node>