doc: Add a few BT-related clarifications

The 'Name' and 'Serial' property take on slightly different meanings in
the case of Bluetooth devices (e.g. HFP).  Update the documentation to
reflect that.

diff --git a/doc/modem-api.txt b/doc/modem-api.txt
index e242bd1..1c4e440 100644 (file)
--- a/doc/modem-api.txt
+++ b/doc/modem-api.txt
@@ -56,7 +56,9 @@ Properties    boolean Powered [readwrite]
 
                string Name [readonly, optional]
 
-                       Friendly name of the modem device.
+                       Friendly name of the modem device.  In the case of
+                       Bluetooth devices (e.g. Type="sap" or "hfp") this
+                       corresponds to the remote device name or it's alias.
 
                string Manufacturer [readonly, optional]
 
@@ -84,6 +86,10 @@ Properties   boolean Powered [readwrite]
 
                        This is usually obtained by using the +CGSN AT command.
 
+                       In the case of Bluetooth devices (e.g. Type="sap" or
+                       "hfp") this corresponds to the Bluetooth Device
+                       Address of the remote device.
+
                array{string} Features [readonly]
 
                        List of currently enabled features. It uses simple