[Commit-gnuradio] r5125 - gnuradio/branches/developers/n4hy/ofdm/gnuradio-core/src/lib/general

[trondeau]

Author: trondeau
Date: 2007-04-26 13:17:02 -0600 (Thu, 26 Apr 2007)
New Revision: 5125

Modified:
   
gnuradio/branches/developers/n4hy/ofdm/gnuradio-core/src/lib/general/gr_stream_mux.h
Log:
doxygenating stream mux block

Modified: 
gnuradio/branches/developers/n4hy/ofdm/gnuradio-core/src/lib/general/gr_stream_mux.h
===================================================================
--- 
gnuradio/branches/developers/n4hy/ofdm/gnuradio-core/src/lib/general/gr_stream_mux.h
        2007-04-26 19:03:10 UTC (rev 5124)
+++ 
gnuradio/branches/developers/n4hy/ofdm/gnuradio-core/src/lib/general/gr_stream_mux.h
        2007-04-26 19:17:02 UTC (rev 5125)
@@ -31,13 +31,32 @@
 class gr_stream_mux;
 typedef boost::shared_ptr<gr_stream_mux> gr_stream_mux_sptr;
 
+/*!
+ * \brief Creates a stream muxing block to multiplex many streams into
+ * one with a specified format.
+ *
+ * \param itemsize the item size of the stream
+ * \param length   a vector (list/tuple) specifying the number of
+ *                 items from each stream the mux together.
+ *                 Warning: this requires that at least as many items
+ *                 per stream are available or the system will wait
+ *                 indefinitely for the items.
+ *
+ */
+
 gr_stream_mux_sptr 
 gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths);
+
+
 /*!
- * \brief take desired numbers of certain signals from multiple inputs and put 
the siganls  
- * consecutively in the output vector. Each input are a serial of int 
variables, same as the     
- * output,  suitable for adding preamble of the ofdm signal used in an ofdm
- * modulator. 
+ * \brief Stream muxing block to multiplex many streams into
+ * one with a specified format.
+ * 
+ * Muxes N streams together producing an output stream that
+ * contains N0 items from the first stream, N1 items from the second,
+ * etc. and repeats:
+ *
+ * [N0, N1, N2, ..., Nm, N0, N1, ...]
  */
 
 class gr_stream_mux : public gr_block