summaryrefslogtreecommitdiff
path: root/gr-qtgui/include/qtgui_time_sink_f.h
diff options
context:
space:
mode:
authorTom Rondeau2011-10-09 18:00:06 -0400
committerTom Rondeau2011-10-09 18:00:06 -0400
commitb0acaef8de114d51920d8c7945481c5ca7b7d104 (patch)
treec7931068b98ba396c8be685cb278ffb2c3e099c7 /gr-qtgui/include/qtgui_time_sink_f.h
parente2b943d6ea4e92d5364a5a31b2feb34d54990b08 (diff)
downloadgnuradio-b0acaef8de114d51920d8c7945481c5ca7b7d104.tar.gz
gnuradio-b0acaef8de114d51920d8c7945481c5ca7b7d104.tar.bz2
gnuradio-b0acaef8de114d51920d8c7945481c5ca7b7d104.zip
docs and qtgui: adding Doxygen documentation for each class. Also changed the default behavior for the qtgui_sink_f to turn the constellation plot off by default (doesn't make sense with out the Q part, too).
Diffstat (limited to 'gr-qtgui/include/qtgui_time_sink_f.h')
-rw-r--r--gr-qtgui/include/qtgui_time_sink_f.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/gr-qtgui/include/qtgui_time_sink_f.h b/gr-qtgui/include/qtgui_time_sink_f.h
index a69d32877..ff17f8a1b 100644
--- a/gr-qtgui/include/qtgui_time_sink_f.h
+++ b/gr-qtgui/include/qtgui_time_sink_f.h
@@ -39,6 +39,15 @@ GR_QTGUI_API qtgui_time_sink_f_sptr qtgui_make_time_sink_f(int size, double bw,
int nconnectons=1,
QWidget *parent=NULL);
+/*!
+ * \brief A graphical sink to display multiple signals in time.
+ * \ingroup qtgui_blk
+ *
+ * This is a QT-based graphical sink the takes set of a float streams
+ * and plots them in the time domain. Each signal is plotted with a
+ * different color, and the \a set_title and \a set_color functions
+ * can be used to change the lable and color for a given input number.
+ */
class GR_QTGUI_API qtgui_time_sink_f : public gr_sync_block
{
private: