r232 - trunk/specifications/otapi
smartphones-commits at lists.linuxtogo.org
smartphones-commits at lists.linuxtogo.org
Sun Apr 20 17:33:21 CEST 2008
Author: mickeylauer
Date: 2008-04-20 17:33:20 +0200 (Sun, 20 Apr 2008)
New Revision: 232
Modified:
trunk/specifications/otapi/org.freesmartphone.GSM.Device.xml.in
trunk/specifications/otapi/org.freesmartphone.GSM.SIM.xml.in
Log:
otapi: docs++
Modified: trunk/specifications/otapi/org.freesmartphone.GSM.Device.xml.in
===================================================================
--- trunk/specifications/otapi/org.freesmartphone.GSM.Device.xml.in 2008-04-20 15:26:24 UTC (rev 231)
+++ trunk/specifications/otapi/org.freesmartphone.GSM.Device.xml.in 2008-04-20 15:33:20 UTC (rev 232)
@@ -18,7 +18,7 @@
<method name="GetInfo">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_device" />
<doc:doc>
- <doc:description>Get information about the manufacturer, model, revision, and IMEI</doc:description>
+ <doc:description>Get information about the manufacturer, model, revision, and IMEI.</doc:description>
<doc:inote>
This maps to the following GSM 07.07 commands
+CGMI (see 3GPP TS 07.07 Chapter 5.1)
@@ -45,7 +45,7 @@
</arg>
<arg type="s" name="imei" direction="out">
<doc:doc>
- <doc:summary>The International Mobile Equipment Identity (IMEI), a world-wide unique ID for this GSM device</doc:summary>
+ <doc:summary>The International Mobile Equipment Identity (IMEI), a world-wide unique ID for this GSM device.</doc:summary>
</doc:doc>
</arg>
</method>
@@ -53,7 +53,7 @@
<method name="GetAntennaPower">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_device" />
<doc:doc>
- <doc:inote>This maps to the GSM 07.07 command +CFUN=?, see 3GPP TS 07.07 Chapter 8.2</doc:inote>
+ <doc:inote>This maps to the GSM 07.07 command +CFUN=?, see 3GPP TS 07.07 Chapter 8.2.</doc:inote>
</doc:doc>
<arg type="b" name="antenna_power" direction="out">
<doc:doc>
@@ -77,17 +77,17 @@
<method name="GetFeatures">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_device" />
<doc:doc>
- <doc:description>Get information about the telephony features supported by this device</doc:description>
- <doc:inote>This maps to the GSM 07.07 command +GCAP, see 3GPP TS 07.07 Chapter 5.8</doc:inote>
+ <doc:description>Get information about the telephony features supported by this device.</doc:description>
+ <doc:inote>This maps to the GSM 07.07 command +GCAP, see 3GPP TS 07.07 Chapter 5.8.</doc:inote>
</doc:doc>
<arg type="a{sv}" name="features" direction="out">
<doc:doc>
<doc:summary>The telephony features supported by this device. Expected tuples are:
- ("GSM", class), ("FAX", class), ("WIRELESS", class), ("GPRS", class)
+ ("GSM", class), ("FAX", class), ("WIRELESS", class), ("GPRS", class).
</doc:summary>
<doc:inote>
This also maps to the GSM 07.07 commands +FCLASS=?, +WS46=?, and +CGCLASS=?,
- see 3GPP TS 07.07 Chapters 5.10, 5.10, and 10.1.11
+ see 3GPP TS 07.07 Chapters 5.10, 5.10, and 10.1.11.
</doc:inote>
</doc:doc>
</arg>
Modified: trunk/specifications/otapi/org.freesmartphone.GSM.SIM.xml.in
===================================================================
--- trunk/specifications/otapi/org.freesmartphone.GSM.SIM.xml.in 2008-04-20 15:26:24 UTC (rev 231)
+++ trunk/specifications/otapi/org.freesmartphone.GSM.SIM.xml.in 2008-04-20 15:33:20 UTC (rev 232)
@@ -34,7 +34,7 @@
<!-- 07.07 8.3 shows many more here, but we will add these
when we actually encounter them in the field -->
</doc:summary>
- <doc:inote>This maps to the GSM 07.07 command +CPIN=?, see 3GPP TS 07.07 Chapter 8.3</doc:inote>
+ <doc:inote>This maps to the GSM 07.07 command +CPIN=?, see 3GPP TS 07.07 Chapter 8.3.</doc:inote>
</doc:doc>
</arg>
</method>
@@ -120,7 +120,7 @@
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Request information about the SIM phonebook.</doc:description>
- <doc:inote>This maps to the GSM 07.07 command +CPBR=?, see 3GPP TS 07.07 Chapter 8.12</doc:inote>
+ <doc:inote>This maps to the GSM 07.07 command +CPBR=?, see 3GPP TS 07.07 Chapter 8.12.</doc:inote>
</doc:doc>
<arg type="a{sv}" name="info" direction="out">
<doc:doc>
@@ -139,7 +139,7 @@
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Delete an entry in the SIM phonebook.</doc:description>
- <doc:inote>This maps to the GSM 07.07 command +CPBW=, see 3GPP TS 07.07 Chapter 8.14</doc:inote>
+ <doc:inote>This maps to the GSM 07.07 command +CPBW=, see 3GPP TS 07.07 Chapter 8.14.</doc:inote>
</doc:doc>
<arg type="i" name="index" direction="in">
<doc:doc>
@@ -152,7 +152,7 @@
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Store an entry in the SIM phonebook.</doc:description>
- <doc:inote>This maps to the GSM 07.07 command +CPBW=, see 3GPP TS 07.07 Chapter 8.14</doc:inote>
+ <doc:inote>This maps to the GSM 07.07 command +CPBW=, see 3GPP TS 07.07 Chapter 8.14.</doc:inote>
</doc:doc>
<arg type="i" name="index" direction="in">
<doc:doc>
@@ -197,7 +197,7 @@
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Request information about the SIM messagebook.</doc:description>
- <doc:inote>This vaguely maps to the GSM 07.05 command +CMGL=?, see 3GPP TS 07.07 Chapter 3.4.2</doc:inote>
+ <doc:inote>This vaguely maps to the GSM 07.05 command +CMGL=?, see 3GPP TS 07.07 Chapter 3.4.2.</doc:inote>
</doc:doc>
<arg type="a{sv}" name="info" direction="out">
<doc:doc>
@@ -215,7 +215,7 @@
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Retrieve phone number of SMS Center Number.</doc:description>
- <doc:inote>This maps to the GSM 07.05 command +CSCA?, see 3GPP TS 07.05 Chapter 3.3.1</doc:inote>
+ <doc:inote>This maps to the GSM 07.05 command +CSCA?, see 3GPP TS 07.05 Chapter 3.3.1.</doc:inote>
</doc:doc>
<arg type="s" name="number" direction="out">
<doc:doc>
@@ -228,7 +228,7 @@
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Set phone number of SMS Center Number.</doc:description>
- <doc:inote>This maps to the GSM 07.05 command +CSCA=(number,type), see 3GPP TS 07.05 Chapter 3.3.1</doc:inote>
+ <doc:inote>This maps to the GSM 07.05 command +CSCA=(number,type), see 3GPP TS 07.05 Chapter 3.3.1.</doc:inote>
</doc:doc>
<arg type="s" name="number" direction="in">
<doc:doc>
@@ -241,7 +241,7 @@
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Delete a message in the SIM messagebook.</doc:description>
- <doc:inote>This maps to the GSM 07.05 command +CMGD=(index), see 3GPP TS 07.05 Chapter 3.5.4</doc:inote>
+ <doc:inote>This maps to the GSM 07.05 command +CMGD=(index), see 3GPP TS 07.05 Chapter 3.5.4.</doc:inote>
</doc:doc>
<arg type="i" name="index" direction="in">
<doc:doc>
@@ -254,7 +254,7 @@
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Store a message in the SIM messagebook.</doc:description>
- <doc:inote>This maps to the GSM 07.05 command +CMGW=..., see 3GPP TS 07.05 Chapter 3.5.3</doc:inote>
+ <doc:inote>This maps to the GSM 07.05 command +CMGW=..., see 3GPP TS 07.05 Chapter 3.5.3.</doc:inote>
</doc:doc>
<arg type="s" name="recipient_number" direction="in">
<doc:doc>
@@ -273,11 +273,16 @@
</arg>
</method>
+ <!-- FIXME Do we want to include "status" and "arrival time" in RetrieveMessage? -->
+
<method name="RetrieveMessage">
<annotation name="org.freedesktop.DBus.GLib.Async" value="fso_gsm_sim" />
<doc:doc>
<doc:description>Retrieve a message from the SIM messagebook.</doc:description>
- <doc:inote>This maps to the GSM 07.05 command +CMGR=(index), see 3GPP TS 07.05 Chapter 3.4.3</doc:inote>
+ <doc:inote>
+ This can map to the GSM 07.05 command +CMGR=(index), see 3GPP TS 07.05 Chapter 3.4.3.
+ It might also map to the GSM 07.05 command +CMGL=(storage_spec), see 3GPP TS 07.05 Chapter 3.4.2.
+ </doc:inote>
</doc:doc>
<arg type="i" name="index" direction="in">
<doc:doc>
More information about the Smartphones-commits
mailing list