summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Rondeau <tom@trondeau.com>2014-07-07 10:53:57 -0400
committerTom Rondeau <tom@trondeau.com>2014-07-07 10:53:57 -0400
commit403933efe1c59ee1cba0da35c9280083108fc3b4 (patch)
treeb447246fdaf54a58c6094e4fefef14181674e093
parentqtgui: updating how freq message ports work. (diff)
parentdocs: Corrects or expands documentation comments for various blocks where I have had to read the source code to understand the (diff)
downloadgnuradio-403933efe1c59ee1cba0da35c9280083108fc3b4.tar.xz
gnuradio-403933efe1c59ee1cba0da35c9280083108fc3b4.zip
Merge branch 'maint'
-rw-r--r--gr-blocks/include/gnuradio/blocks/char_to_short.h7
-rw-r--r--gr-blocks/include/gnuradio/blocks/delay.h3
-rw-r--r--gr-blocks/include/gnuradio/blocks/file_descriptor_sink.h3
-rw-r--r--gr-blocks/include/gnuradio/blocks/file_descriptor_source.h3
-rw-r--r--gr-blocks/include/gnuradio/blocks/short_to_char.h4
-rw-r--r--gr-filter/lib/firdes.cc2
6 files changed, 16 insertions, 6 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/char_to_short.h b/gr-blocks/include/gnuradio/blocks/char_to_short.h
index 05880e073..6f326c8da 100644
--- a/gr-blocks/include/gnuradio/blocks/char_to_short.h
+++ b/gr-blocks/include/gnuradio/blocks/char_to_short.h
@@ -30,13 +30,14 @@ namespace gr {
namespace blocks {
/*!
- * \brief Convert stream of chars to a stream of short
+ * \brief Convert stream of chars to a stream of shorts.
* \ingroup type_converters_blk
*
* \details
- * Converts \p vlen length vectors of input char samples to shorts:
+ * Converts \p vlen length vectors of input char samples to shorts,
+ * multiplying each element by 256:
*
- * \li output[0][m:m+vlen] = static_cast<short>(input[0][m:m+vlen])
+ * \li output[0][m:m+vlen] = 256 * static_cast<short>(input[0][m:m+vlen])
*/
class BLOCKS_API char_to_short : virtual public sync_block
{
diff --git a/gr-blocks/include/gnuradio/blocks/delay.h b/gr-blocks/include/gnuradio/blocks/delay.h
index bae5e40a8..fc90e2249 100644
--- a/gr-blocks/include/gnuradio/blocks/delay.h
+++ b/gr-blocks/include/gnuradio/blocks/delay.h
@@ -32,6 +32,9 @@ namespace gr {
/*!
* \brief delay the input by a certain number of samples
* \ingroup misc_blk
+ *
+ * Positive delays insert zero items at the beginning of the stream.
+ * Negative delays discard items from the stream.
*/
class BLOCKS_API delay : virtual public block
{
diff --git a/gr-blocks/include/gnuradio/blocks/file_descriptor_sink.h b/gr-blocks/include/gnuradio/blocks/file_descriptor_sink.h
index 31ec0cc14..6399aec85 100644
--- a/gr-blocks/include/gnuradio/blocks/file_descriptor_sink.h
+++ b/gr-blocks/include/gnuradio/blocks/file_descriptor_sink.h
@@ -40,7 +40,8 @@ namespace gr {
typedef boost::shared_ptr<file_descriptor_sink> sptr;
/*!
- * Build a file descriptor sink block.
+ * Build a file descriptor sink block. The provided file descriptor will
+ * be closed when the sink is destroyed.
*
* \param itemsize item size of the incoming data stream.
* \param fd file descriptor (as an integer).
diff --git a/gr-blocks/include/gnuradio/blocks/file_descriptor_source.h b/gr-blocks/include/gnuradio/blocks/file_descriptor_source.h
index 6292b6357..d78b10a84 100644
--- a/gr-blocks/include/gnuradio/blocks/file_descriptor_source.h
+++ b/gr-blocks/include/gnuradio/blocks/file_descriptor_source.h
@@ -46,7 +46,8 @@ namespace gr {
typedef boost::shared_ptr<file_descriptor_source> sptr;
/*!
- * Build a file descriptor source block.
+ * Build a file descriptor source block. The provided file descriptor will
+ * be closed when the sink is destroyed.
*
* \param itemsize item size of the incoming data stream.
* \param fd file descriptor (as an integer).
diff --git a/gr-blocks/include/gnuradio/blocks/short_to_char.h b/gr-blocks/include/gnuradio/blocks/short_to_char.h
index 22a157d34..a80e6dc63 100644
--- a/gr-blocks/include/gnuradio/blocks/short_to_char.h
+++ b/gr-blocks/include/gnuradio/blocks/short_to_char.h
@@ -38,6 +38,10 @@ namespace gr {
* [0x00ff, 0x0ff0, 0xff00] => [0x00, 0x0f, 0xff]
*
* \ingroup type_converters_blk
+ *
+ * \details
+ * Converts \p vlen length vectors of input short samples to chars,
+ * dividing each element by 256.
*/
class BLOCKS_API short_to_char : virtual public sync_block
{
diff --git a/gr-filter/lib/firdes.cc b/gr-filter/lib/firdes.cc
index cb6bffd18..1726d0bed 100644
--- a/gr-filter/lib/firdes.cc
+++ b/gr-filter/lib/firdes.cc
@@ -720,7 +720,7 @@ namespace gr {
throw std::out_of_range("firdes check failed: 0 < fa <= sampling_freq / 2");
if(transition_width <= 0)
- throw std::out_of_range("gr_dirdes check failed: transition_width > 0");
+ throw std::out_of_range("firdes check failed: transition_width > 0");
}
void