diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2012-12-19 17:51:21 +0100 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2012-12-19 17:51:21 +0100 |
| commit | ae0d77e7d63a7666be6c3cc277a9e94a0badc254 (patch) | |
| tree | 688927f0b39c32754191c37b7e6f513ab3711421 /doc/adapter-api.txt | |
| parent | 0cc2fb37f479ecdb2d10a23d526dbcff88ca9385 (diff) | |
| download | bluez-ae0d77e7d63a7666be6c3cc277a9e94a0badc254.tar.gz | |
doc: Add extra comments about default values to adapter properties
Diffstat (limited to 'doc/adapter-api.txt')
| -rw-r--r-- | doc/adapter-api.txt | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt index 7a587fb61..1ccd9439f 100644 --- a/doc/adapter-api.txt +++ b/doc/adapter-api.txt @@ -64,7 +64,7 @@ Properties string Address [readonly] boolean Powered [readwrite] Switch an adapter on or off. This will also set the - appropriate connectable state. + appropriate connectable state of the controller. boolean Discoverable [readwrite] @@ -84,6 +84,8 @@ Properties string Address [readonly] this property will be updated via a PropertyChanged signal. + For any new adapter this settings defaults to false. + boolean Pairable [readwrite] Switch an adapter to pairable or non-pairable. This is @@ -93,12 +95,17 @@ Properties string Address [readonly] Note that this property only affects incoming pairing requests. + For any new adapter this settings defaults to true. + uint32 PairableTimeout [readwrite] The pairable timeout in seconds. A value of zero means that the timeout is disabled and it will stay in pairable mode forever. + The default value for pairable timeout should be + disabled (value 0). + uint32 DiscoverableTimeout [readwrite] The discoverable timeout in seconds. A value of zero |