From: Marko Saukko <marko.saukko@gmail.com>
To: ofono@ofono.org
Subject: [PATCH] API documentation fixes
Date: Fri, 16 Oct 2009 12:47:48 +0300 [thread overview]
Message-ID: <4AD84144.3060602@gmail.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 2939 bytes --]
Hi,
Fixes for API documentation.
Regards,
Marko
---
doc/call-settings-api.txt | 4 ++--
doc/sim-api.txt | 10 +++++-----
doc/voicecall-api.txt | 2 +-
doc/voicecallmanager-api.txt | 2 +-
4 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/doc/call-settings-api.txt b/doc/call-settings-api.txt
index 870c748..5e5eb40 100644
--- a/doc/call-settings-api.txt
+++ b/doc/call-settings-api.txt
@@ -1,7 +1,7 @@
-Call Forwarding hierarchy
+Call Settings hierarchy
===============
Service org.ofono
-Interface org.ofono.CallForwarding
+Interface org.ofono.CallSettings
Object path [variable prefix]/{modem0,modem1,...}
Methods dict GetProperties()
diff --git a/doc/sim-api.txt b/doc/sim-api.txt
index 11ee4c8..9fe9a92 100644
--- a/doc/sim-api.txt
+++ b/doc/sim-api.txt
@@ -12,22 +12,22 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
- ChangePin(string type, string oldpin, string newpin)
+ void ChangePin(string type, string oldpin, string newpin)
Changes the pin given by string type.
- EnterPin(string type, string pin)
+ void EnterPin(string type, string pin)
Enters the currently pending pin. The type value must
match the pin type being asked in the PinRequired
property.
- ResetPin(string type, string puk, string newpin)
+ void ResetPin(string type, string puk, string newpin)
Provides the unblock key to the modem and if correct
resets the pin to the new value of newpin.
- LockPin(string type, string pin)
+ void LockPin(string type, string pin)
Activates the lock for the particular pin type. The
device will ask for a PIN automatically next time the
@@ -35,7 +35,7 @@ Methods dict GetProperties()
re-inserter. The current PIN is required for the
operation to succeed.
- UnlockPin(string type, string pin)
+ void UnlockPin(string type, string pin)
Deactivates the lock for the particular pin type. The
current PIN is required for the operation to succeed.
diff --git a/doc/voicecall-api.txt b/doc/voicecall-api.txt
index 62db5a1..b360cca 100644
--- a/doc/voicecall-api.txt
+++ b/doc/voicecall-api.txt
@@ -3,7 +3,7 @@ VoiceCall hierarchy
Service org.ofono
Interface org.ofono.VoiceCall
-Object path [variable prefix]/{modem0,modem1,...}/{call0,call1,...}
+Object path [variable prefix]/{modem0,modem1,...}/{voicecall01,voicecall02,...}
Methods dict GetProperties()
diff --git a/doc/voicecallmanager-api.txt b/doc/voicecallmanager-api.txt
index 361370a..7877ac5 100644
--- a/doc/voicecallmanager-api.txt
+++ b/doc/voicecallmanager-api.txt
@@ -70,7 +70,7 @@ Methods dict GetProperties()
Held calls is invalid, since in GSM a user can have
only a single Held call at a time.
- void HangupAllCalls()
+ void HangupAll()
Releases all calls.
--
1.6.0.4
next reply other threads:[~2009-10-16 9:47 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-10-16 9:47 Marko Saukko [this message]
2009-10-16 18:22 ` [PATCH] API documentation fixes Denis Kenzior
2009-10-16 19:18 ` Bastian, Waldo
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4AD84144.3060602@gmail.com \
--to=marko.saukko@gmail.com \
--cc=ofono@ofono.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.