From 4eb2886ca90f686de981f63ea866c5b7a07da155 Mon Sep 17 00:00:00 2001
From: Pavel Kirienko <pavel.kirienko@gmail.com>
Date: Thu, 20 Feb 2014 20:36:40 +0400
Subject: [PATCH] Doc comment

---
 .../include/uavcan/internal/marshalling/bit_stream.hpp     | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/libuavcan/include/uavcan/internal/marshalling/bit_stream.hpp b/libuavcan/include/uavcan/internal/marshalling/bit_stream.hpp
index f7a09b2c01..2cce87c695 100644
--- a/libuavcan/include/uavcan/internal/marshalling/bit_stream.hpp
+++ b/libuavcan/include/uavcan/internal/marshalling/bit_stream.hpp
@@ -42,6 +42,13 @@ public:
         StaticAssert<sizeof(uint8_t) == 1>::check();
     }
 
+    /**
+     * Write/read calls interpret bytes as bit arrays, 8 bits per byte, where the most
+     * significant bits have lower index, i.e.:
+     *   Hex:     55       2d
+     *   Bits:    01010101 00101101
+     *   Indices: 0  ..  7 8  ..  15
+     */
     int write(const uint8_t* bytes, const int bitlen);
     int read(uint8_t* bytes, const int bitlen);