From 1b5f4ab3bfc53090d274d69053bf75537f1c08ed Mon Sep 17 00:00:00 2001
From: Andrej Rode <andrej.rode@ettus.com>
Date: Thu, 16 Mar 2017 12:42:46 -0700
Subject: docs: document common exceptions occuring in multi_usrp::make

---
 host/include/uhd/usrp/multi_usrp.hpp | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'host/include')

diff --git a/host/include/uhd/usrp/multi_usrp.hpp b/host/include/uhd/usrp/multi_usrp.hpp
index 1a64a8f3a..fee430fe0 100644
--- a/host/include/uhd/usrp/multi_usrp.hpp
+++ b/host/include/uhd/usrp/multi_usrp.hpp
@@ -120,6 +120,8 @@ public:
      * Make a new multi usrp from the device address.
      * \param dev_addr the device address
      * \return a new single usrp object
+     * \throws uhd::key_error no device found
+     * \throws uhd::index_error fewer devices found than expected
      */
     static sptr make(const device_addr_t &dev_addr);
 
-- 
cgit v1.2.3


From e11796b79d33e194eb9e3bdb2e5a78fed8a9da49 Mon Sep 17 00:00:00 2001
From: Martin Braun <martin.braun@ettus.com>
Date: Fri, 24 Mar 2017 10:01:59 -0700
Subject: docs: Further clarification on CHDR

---
 host/docs/vrt_chdr.dox         | 24 ++++++++++++------------
 host/include/uhd/types/sid.hpp |  8 +++++++-
 2 files changed, 19 insertions(+), 13 deletions(-)

(limited to 'host/include')

diff --git a/host/docs/vrt_chdr.dox b/host/docs/vrt_chdr.dox
index a2d36c93e..8675349f9 100644
--- a/host/docs/vrt_chdr.dox
+++ b/host/docs/vrt_chdr.dox
@@ -51,20 +51,20 @@ Bits   | Meaning
 60     | End-of-burst or error flag
 59:48  | 12-bit sequence number
 47:32  | Total packet length in Bytes
-31:0   | Stream ID (SID)
-
+31:0   | Stream ID (SID). For the format of SID, see uhd::sid_t.
 
 The packet type is determined mainly by the first two bits, although
-the EOB or error flag are also taken into consideration:
-
-Bit 63 | Bit 62 | Bit 60 | Packet Type
--------|--------|--------|--------------
-0      | 0      | 0      | Data
-0      | 0      | 1      | Data (End-of-burst)
-0      | 1      | 0      | Flow Control
-1      | 0      | 0      | Command Packet
-1      | 1      | 0      | Command Response
-1      | 1      | 1      | Command Response (Error)
+the EOB or error flag are also taken into consideration (the third bit does not
+affect the packet type):
+
+Bit 63 | Bit 62 | Bit 61 | Bit 60 | Packet Type
+-------|--------|--------|--------|--------------
+0      | 0      | x      | 0      | Data
+0      | 0      | x      | 1      | Data (End-of-burst)
+0      | 1      | x      | 0      | Flow Control
+1      | 0      | x      | 0      | Command Packet
+1      | 1      | x      | 0      | Command Response
+1      | 1      | x      | 1      | Command Response (Error)
 
 \section vrt_tools Tools
 
diff --git a/host/include/uhd/types/sid.hpp b/host/include/uhd/types/sid.hpp
index 5ea8e8f41..5c31f2d5a 100644
--- a/host/include/uhd/types/sid.hpp
+++ b/host/include/uhd/types/sid.hpp
@@ -40,7 +40,13 @@ namespace uhd {
      * is required, we use the combination of the 8-bit address and the 8-bit
      * endpoint.
      *
-     * \section sid_str_repr String Representation
+     * <pre>
+     * +-------------+--------------+-------------+--------------+
+     * | SRC address | SRC endpoint | DST address | DST endpoint |
+     * +-------------+--------------+-------------+--------------+
+     * </pre>
+     *
+     * \section sid_str_repr String Representation (pretty printing)
      *
      * The string representation of a SID is of the form
      *
-- 
cgit v1.2.3