2011-03-28 14:21:55

by Dmitriy Paliy

Subject: [PATCH 0/2 v2] Update Adapter API documentation

Hi,

This is a new proposal to make it more readable.

Br,
Dmitriy

2011-03-28 14:26:17

by Johan Hedberg

Subject: Re: [PATCH 0/2 v2] Update Adapter API documentation

Hi Dmitriy,

On Mon, Mar 28, 2011, Dmitriy Paliy wrote:
> This is a new proposal to make it more readable.

Thanks. Both patches have been pushed upstream.

Johan

2011-03-28 14:21:57

by Dmitriy Paliy

Subject: [PATCH 2/2] Update Media API documentation

Possible error responses are added to RegisterEndpoint.
---
doc/media-api.txt | 5 +++++
1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/doc/media-api.txt b/doc/media-api.txt
index 84903d6..b2f239a 100644
--- a/doc/media-api.txt
+++ b/doc/media-api.txt
@@ -35,6 +35,11 @@ Methods void RegisterEndpoint(object endpoint, dict properties)
Capabilities blob, it is used as it is
so the size and byte order must match.

+ Possible Errors: org.bluez.Error.InvalidArguments
+ org.bluez.Error.NotSupported - emitted
+ when interface for the end-point is
+ disabled.
+
void UnregisterEndpoint(object endpoint)

Unregister sender end point.
--
1.7.1

2011-03-28 14:21:56

by Dmitriy Paliy

Subject: [PATCH 1/2] Update Adapter API documentation

RequestSession and ReleaseSession description is updated in adapter
API.
---
doc/adapter-api.txt | 18 ++++++++++++++----
1 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 5272d74..f34d58f 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -31,15 +31,25 @@ Methods dict GetProperties()

void RequestSession()

- This method will request a client session that
- provides operational Bluetooth. A possible mode
- change must be confirmed by the user via the agent.
+ This method requests a client session that provides
+ operational Bluetooth. A possible mode change must be
+ confirmed by the user via the agent.
+
+ Clients may request multiple sessions. All sessions
+ are released when adapter's mode is changed to off
+ state.

Possible Errors: org.bluez.Error.Rejected

void ReleaseSession()

- Release a previous requested session.
+ Release a previously requested session. It sets
+ adapter to the mode in use on the moment of session
+ request.
+
+ SetProperty method call changes adapter's mode
+ persistently, such that session release will not
+ modify it.

Possible Errors: org.bluez.Error.DoesNotExist

--
1.7.1