linux-bluetooth.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mikel Astiz <mikel.astiz.oss@gmail.com>
To: linux-bluetooth@vger.kernel.org
Cc: Mikel Astiz <mikel.astiz@bmw-carit.de>
Subject: [PATCH obexd v0 3/4] client-doc: Rephrase ambiguities in PBAP interface
Date: Fri, 20 Jul 2012 13:02:27 +0200	[thread overview]
Message-ID: <1342782148-10684-3-git-send-email-mikel.astiz.oss@gmail.com> (raw)
In-Reply-To: <1342782148-10684-1-git-send-email-mikel.astiz.oss@gmail.com>

From: Mikel Astiz <mikel.astiz@bmw-carit.de>

Rephrase method descriptions that can be misleading or are not clear
enough.
---
 doc/client-api.txt |   22 ++++++++++++++--------
 1 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/doc/client-api.txt b/doc/client-api.txt
index 8202f39..8621df8 100644
--- a/doc/client-api.txt
+++ b/doc/client-api.txt
@@ -224,14 +224,15 @@ Methods		void Select(string location, string phonebook)
 
 		array{string vcard, string name} List()
 
-			Return an array of vcard-listing data which contains the
-			vcard : name paired string, for example "1.vcf" :
-				"John".
+			Return an array of vcard-listing data where every entry
+			consists of a pair of strings containing the vcard
+			handle and the contact name. For example:
+				"1.vcf" : "John"
 
 		object, dict Pull(string vcard, string targetfile)
 
-			Retrieve the vcard in the current phonebook object and
-			store it in a local file.
+			Given a vcard handle, retrieve the vcard in the current
+			phonebook object and store it in a local file.
 
 			If an empty target file is given, a name will be
 			automatically calculated for the temporary file.
@@ -246,7 +247,11 @@ Methods		void Select(string location, string phonebook)
 		array{string vcard, string name}
 		Search(string field, string value)
 
-			Return an array of vcard-listing data which contains the
+			Search for entries matching the given condition and
+			return an array of vcard-listing data where every entry
+			consists of a pair of strings containing the vcard
+			handle and the contact name.
+
 			vcard : name paired string match the search condition.
 
 			field : the field in the vcard to search with
@@ -255,8 +260,9 @@ Methods		void Select(string location, string phonebook)
 
 		uint16 GetSize()
 
-			Return the number of the non-null entries in the
-			selected phonebook object.
+			Return the number of entries in the selected phonebook
+			object that are actually used (i.e. indexes that
+			correspond to non-NULL entries).
 
 		void SetFormat(string format)
 
-- 
1.7.7.6


  parent reply	other threads:[~2012-07-20 11:02 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-20 11:02 [PATCH obexd v0 1/4] client-doc: Fix typo Mikel Astiz
2012-07-20 11:02 ` [PATCH obexd v0 2/4] client-doc: Minor style fix Mikel Astiz
2012-07-20 11:02 ` Mikel Astiz [this message]
2012-07-20 11:02 ` [PATCH obexd v0 4/4] client-doc: Describe session properties Mikel Astiz
2012-07-20 14:19 ` [PATCH obexd v0 1/4] client-doc: Fix typo Luiz Augusto von Dentz

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=1342782148-10684-3-git-send-email-mikel.astiz.oss@gmail.com \
    --to=mikel.astiz.oss@gmail.com \
    --cc=linux-bluetooth@vger.kernel.org \
    --cc=mikel.astiz@bmw-carit.de \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).