diff options
| author | Marcel Holtmann <marcel@holtmann.org> | 2012-12-19 17:57:39 +0100 |
|---|---|---|
| committer | Marcel Holtmann <marcel@holtmann.org> | 2012-12-19 17:57:39 +0100 |
| commit | c7c9de0ed945cef132ee73fc30f5709fadc9dd98 (patch) | |
| tree | f398486d58ad06ce7d6f1f24e556650b1855b138 /doc/device-api.txt | |
| parent | ae0d77e7d63a7666be6c3cc277a9e94a0badc254 (diff) | |
| download | bluez-c7c9de0ed945cef132ee73fc30f5709fadc9dd98.tar.gz | |
doc: Add comment to favor Alias over Name property for devices
Diffstat (limited to 'doc/device-api.txt')
| -rw-r--r-- | doc/device-api.txt | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/device-api.txt b/doc/device-api.txt index 4265acfd2..8dff0f837 100644 --- a/doc/device-api.txt +++ b/doc/device-api.txt @@ -98,6 +98,13 @@ Properties string Address [readonly] The Bluetooth remote name. This value can not be changed. Use the Alias property instead. + This value is only present for completeness. It is + better to always use the Alias property when + displaying the devices name. + + If the Alias property is unset, it will reflect + this value which makes is more convenient. + uint16 Vendor [readonly] [optional] Vendor unique numeric identifier. |