summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio/blocks/short_to_char.h
diff options
context:
space:
mode:
authorTim Kuester <tpkuester@gmail.com>2014-04-15 16:59:53 -0400
committerTim Kuester <tpkuester@gmail.com>2014-04-15 17:02:02 -0400
commit850d5ca30cd10a3cf1edaf46234690c5dca3e5c4 (patch)
tree91d1134b67a3691db7718b180d6809f63634e1e4 /gr-blocks/include/gnuradio/blocks/short_to_char.h
parent76970d54f3a6551751d481c63ea54c0794fc2591 (diff)
documentation: Bit handling gotchas explained
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/short_to_char.h')
-rw-r--r--gr-blocks/include/gnuradio/blocks/short_to_char.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/short_to_char.h b/gr-blocks/include/gnuradio/blocks/short_to_char.h
index de4df623a1..22a157d341 100644
--- a/gr-blocks/include/gnuradio/blocks/short_to_char.h
+++ b/gr-blocks/include/gnuradio/blocks/short_to_char.h
@@ -31,6 +31,12 @@ namespace gr {
/*!
* \brief Convert stream of shorts to a stream of chars.
+ *
+ * This block strips off the least significant byte from the
+ * short value.
+ *
+ * [0x00ff, 0x0ff0, 0xff00] => [0x00, 0x0f, 0xff]
+ *
* \ingroup type_converters_blk
*/
class BLOCKS_API short_to_char : virtual public sync_block