summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio/blocks/complex_to_float.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/complex_to_float.h')
-rw-r--r--gr-blocks/include/gnuradio/blocks/complex_to_float.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/complex_to_float.h b/gr-blocks/include/gnuradio/blocks/complex_to_float.h
index c7b4a48805..40fcb729b4 100644
--- a/gr-blocks/include/gnuradio/blocks/complex_to_float.h
+++ b/gr-blocks/include/gnuradio/blocks/complex_to_float.h
@@ -30,8 +30,14 @@ namespace gr {
namespace blocks {
/*!
- * \brief convert a stream of gr_complex to 1 or 2 streams of float
+ * \brief Convert a stream of gr_complex to 1 or 2 streams of float.
* \ingroup type_converters_blk
+ *
+ * \details
+ * If a single output stream is attached, this will output the
+ * real part of the input complex samples. If a second output
+ * stream is connected, output[0] is the real part and output[1]
+ * is the imaginary part.
*/
class BLOCKS_API complex_to_float : virtual public sync_block
{