summaryrefslogtreecommitdiff
path: root/gr-blocks/include/blocks/float_to_int.h
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2013-04-03 19:33:32 -0400
committerTom Rondeau <trondeau@vt.edu>2013-04-04 10:38:29 -0400
commitd44322fd03661c1eb6e45e3e364e81bb5131239b (patch)
tree17c068dc4081f9bbdeaeb046ca20ee53794b2e27 /gr-blocks/include/blocks/float_to_int.h
parent9ce3e6b3f658b9273f048e1a3580be65dc08bef1 (diff)
docs: updating Doxygen categories for all blocks.
Block categories in Doxygen now match where they are in GRC's category tree.
Diffstat (limited to 'gr-blocks/include/blocks/float_to_int.h')
-rw-r--r--gr-blocks/include/blocks/float_to_int.h14
1 files changed, 8 insertions, 6 deletions
diff --git a/gr-blocks/include/blocks/float_to_int.h b/gr-blocks/include/blocks/float_to_int.h
index 95c62e5162..3c8e7ad5ab 100644
--- a/gr-blocks/include/blocks/float_to_int.h
+++ b/gr-blocks/include/blocks/float_to_int.h
@@ -30,19 +30,21 @@ namespace gr {
namespace blocks {
/*!
- * \brief Convert stream of floats to a stream of char
- * \ingroup converter_blk
- *
- * \param vlen vector length of data streams.
- * \param scale a scalar multiplier to change the output signal scale.
+ * \brief Convert stream of floats to a stream of ints.
+ * \ingroup type_converters_blk
*/
class BLOCKS_API float_to_int : virtual public gr_sync_block
{
public:
-
// gr::blocks::float_to_int_ff::sptr
typedef boost::shared_ptr<float_to_int> sptr;
+ /*!
+ * Build a float to int block.
+ *
+ * \param vlen vector length of data streams.
+ * \param scale a scalar multiplier to change the output signal scale.
+ */
static sptr make(size_t vlen=1, float scale=1.0);
/*!