From c7c9de0ed945cef132ee73fc30f5709fadc9dd98 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Wed, 19 Dec 2012 17:57:39 +0100 Subject: [PATCH] doc: Add comment to favor Alias over Name property for devices --- doc/device-api.txt | 7 +++++++ 1 file changed, 7 insertions(+) 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. -- 2.47.3