2012-07-20 11:02:25

by Mikel Astiz

Subject: [PATCH obexd v0 1/4] client-doc: Fix typo

From: Mikel Astiz <[email protected]>

---
doc/client-api.txt | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/doc/client-api.txt b/doc/client-api.txt
index 1938a38..11b79be 100644
--- a/doc/client-api.txt
+++ b/doc/client-api.txt
@@ -288,7 +288,7 @@ Methods void Select(string location, string phonebook)
array{string} ListFilterFields()

Return All Available fields that can be used in
- SefFilter method.
+ SetFilter method.

array{string} GetFilter()

--
1.7.7.6

2012-07-20 14:19:26

by Luiz Augusto von Dentz

Subject: Re: [PATCH obexd v0 1/4] client-doc: Fix typo

Hi Mikel,

On Fri, Jul 20, 2012 at 2:02 PM, Mikel Astiz <[email protected]> wrote:
> From: Mikel Astiz <[email protected]>
>
> ---
> doc/client-api.txt | 2 +-
> 1 files changed, 1 insertions(+), 1 deletions(-)
>
> diff --git a/doc/client-api.txt b/doc/client-api.txt
> index 1938a38..11b79be 100644
> --- a/doc/client-api.txt
> +++ b/doc/client-api.txt
> @@ -288,7 +288,7 @@ Methods void Select(string location, string phonebook)
> array{string} ListFilterFields()
>
> Return All Available fields that can be used in
> - SefFilter method.
> + SetFilter method.
>
> array{string} GetFilter()
>
> --
> 1.7.7.6

Patches 1-3 pushed, thanks.


--
Luiz Augusto von Dentz

2012-07-20 11:02:27

by Mikel Astiz

Subject: [PATCH obexd v0 3/4] client-doc: Rephrase ambiguities in PBAP interface

From: Mikel Astiz <[email protected]>

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

2012-07-20 11:02:28

by Mikel Astiz

Subject: [PATCH obexd v0 4/4] client-doc: Describe session properties

From: Mikel Astiz <[email protected]>

Add a short description of the session properties to be consistent with
the rest of the documentation.
---
doc/client-api.txt | 6 ++++++
1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/doc/client-api.txt b/doc/client-api.txt
index 8621df8..c0cca2d 100644
--- a/doc/client-api.txt
+++ b/doc/client-api.txt
@@ -53,10 +53,16 @@ Methods dict GetProperties()

Properties string Source [readonly]

+ Bluetooth address of the local adapter.
+
string Destination [readonly]

+ Bluetooth address of remote device.
+
byte Channel [readonly]

+ RFCOMM channel number being used.
+
Object Push hierarchy
=====================

--
1.7.7.6

2012-07-20 11:02:26

by Mikel Astiz

Subject: [PATCH obexd v0 2/4] client-doc: Minor style fix

From: Mikel Astiz <[email protected]>

Fix lines that are over 80 columns.
---
doc/client-api.txt | 3 ++-
1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/doc/client-api.txt b/doc/client-api.txt
index 11b79be..8202f39 100644
--- a/doc/client-api.txt
+++ b/doc/client-api.txt
@@ -361,7 +361,8 @@ Methods void SetFolder(string name)

string Name : Folder name

- array{object, dict} GetMessageListing(string folder, dict filter)
+ array{object, dict} GetMessageListing(string folder,
+ dict filter)

Returns an array containing the messages found in the
given folder.
--
1.7.7.6