diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-04-03 19:33:32 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-04-04 10:38:29 -0400 |
| commit | d44322fd03661c1eb6e45e3e364e81bb5131239b (patch) | |
| tree | 17c068dc4081f9bbdeaeb046ca20ee53794b2e27 /gr-blocks/include/blocks/endian_swap.h | |
| parent | 9ce3e6b3f658b9273f048e1a3580be65dc08bef1 (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/endian_swap.h')
| -rw-r--r-- | gr-blocks/include/blocks/endian_swap.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/gr-blocks/include/blocks/endian_swap.h b/gr-blocks/include/blocks/endian_swap.h index 4b5a76218e..c26a1d2aa4 100644 --- a/gr-blocks/include/blocks/endian_swap.h +++ b/gr-blocks/include/blocks/endian_swap.h @@ -31,9 +31,7 @@ namespace gr { /*! * \brief Convert stream of items into thier byte swapped version - * - * \param item_size_bytes number of bytes per item, 1=no-op, - * 2=uint16_t, 4=uint32_t, 8=uint64_t + * \ingroup stream_operators_blk */ class BLOCKS_API endian_swap : virtual public gr_sync_block { @@ -41,6 +39,12 @@ namespace gr { // gr::blocks::endian_swap::sptr typedef boost::shared_ptr<endian_swap> sptr; + /*! + * Make an endian swap block. + * + * \param item_size_bytes number of bytes per item, 1=no-op, + * 2=uint16_t, 4=uint32_t, 8=uint64_t + */ static sptr make(size_t item_size_bytes=1); }; |