OSDN Git Service

doc: Fix optional properties not marked as such
authorMikel Astiz <mikel.astiz@bmw-carit.de>
Thu, 25 Apr 2013 07:33:55 +0000 (09:33 +0200)
committerJohan Hedberg <johan.hedberg@intel.com>
Thu, 25 Apr 2013 07:37:36 +0000 (10:37 +0300)
Commit 826023de56896e83f35ae69a73d6a120a2f5b11e made some of the
device's properties optional but the documentation was not updated
accordingly. More specifically, the properties 'Name' and 'UUIDs' won't
be present if the information is not available.

doc/device-api.txt

index 0f916c7..187f2bf 100644 (file)
@@ -96,7 +96,7 @@ Properties    string Address [readonly]
 
                        The Bluetooth device address of the remote device.
 
-               string Name [readonly]
+               string Name [readonly, optional]
 
                        The Bluetooth remote name. This value can not be
                        changed. Use the Alias property instead.
@@ -121,7 +121,7 @@ Properties  string Address [readonly]
 
                        External appearance of device, as found on GAP service.
 
-               array{string} UUIDs [readonly]
+               array{string} UUIDs [readonly, optional]
 
                        List of 128-bit UUIDs that represents the available
                        remote services.