diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-04-04 11:50:35 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-04-04 12:37:40 -0400 |
| commit | 8b1303bbb0bf72569a5149082796f50b6e8f9a5b (patch) | |
| tree | 5809962a19338db21f28957535529552d12992a1 /gr-qtgui | |
| parent | 2930f1b4265b794599d814e9a3d68fd03bde010f (diff) | |
docs: fixes for merge conflicts and differences between master/next.
Diffstat (limited to 'gr-qtgui')
28 files changed, 97 insertions, 22 deletions
diff --git a/gr-qtgui/grc/qtgui_block_tree.xml b/gr-qtgui/grc/qtgui_block_tree.xml index 3eaaf49295..ac6eef7599 100644 --- a/gr-qtgui/grc/qtgui_block_tree.xml +++ b/gr-qtgui/grc/qtgui_block_tree.xml @@ -29,16 +29,16 @@ <cat> <name></name> <!-- Blank for Root Name --> <cat> - <name>QT GUI Sinks</name> - <block>qtgui_sink_x</block> + <name>Instrumentation/QT</name> <block>qtgui_freq_sink_x</block> <block>qtgui_time_sink_x</block> <block>qtgui_const_sink_x</block> <block>qtgui_waterfall_sink_x</block> <block>qtgui_time_raster_sink_x</block> + <block>qtgui_sink_x</block> </cat> <cat> - <name>QT GUI Widgets</name> + <name>GUI Widgets/QT</name> <block>qtgui_tab_widget</block> <block>variable_qtgui_range</block> <block>variable_qtgui_chooser</block> diff --git a/gr-qtgui/grc/qtgui_chooser.xml b/gr-qtgui/grc/qtgui_chooser.xml index 98c94b5e5b..6a8760cbe6 100644 --- a/gr-qtgui/grc/qtgui_chooser.xml +++ b/gr-qtgui/grc/qtgui_chooser.xml @@ -8,7 +8,6 @@ <block> <name>QT GUI Chooser</name> <key>variable_qtgui_chooser</key> - <category>GUI Widgets/QT</category> <import>from PyQt4 import Qt</import> <var_make>self.$(id) = $(id) = $value</var_make> <make>#slurp diff --git a/gr-qtgui/include/qtgui/ConstellationDisplayPlot.h b/gr-qtgui/include/qtgui/ConstellationDisplayPlot.h index 2c33a74301..041e72d45f 100644 --- a/gr-qtgui/include/qtgui/ConstellationDisplayPlot.h +++ b/gr-qtgui/include/qtgui/ConstellationDisplayPlot.h @@ -28,6 +28,10 @@ #include <vector> #include <qtgui/DisplayPlot.h> +/*! + * \brief QWidget for displaying constellaton (I&Q) plots. + * \ingroup qtgui_blk + */ class ConstellationDisplayPlot : public DisplayPlot { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/DisplayPlot.h b/gr-qtgui/include/qtgui/DisplayPlot.h index d9ee16e087..aee9ce5880 100644 --- a/gr-qtgui/include/qtgui/DisplayPlot.h +++ b/gr-qtgui/include/qtgui/DisplayPlot.h @@ -46,6 +46,10 @@ typedef QList<QColor> QColorList; Q_DECLARE_METATYPE ( QColorList ) +/*! + * \brief QWidget base plot to build QTGUI plotting tools. + * \ingroup qtgui_blk + */ class DisplayPlot:public QwtPlot{ Q_OBJECT diff --git a/gr-qtgui/include/qtgui/FrequencyDisplayPlot.h b/gr-qtgui/include/qtgui/FrequencyDisplayPlot.h index ae438f143f..a835e7de08 100644 --- a/gr-qtgui/include/qtgui/FrequencyDisplayPlot.h +++ b/gr-qtgui/include/qtgui/FrequencyDisplayPlot.h @@ -28,6 +28,10 @@ #include <vector> #include <qtgui/DisplayPlot.h> +/*! + * \brief QWidget for displaying frequency domain (PSD) plots. + * \ingroup qtgui_blk + */ class FrequencyDisplayPlot: public DisplayPlot { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/SpectrumGUIClass.h b/gr-qtgui/include/qtgui/SpectrumGUIClass.h index 48b6a37501..ebe08bdb85 100644 --- a/gr-qtgui/include/qtgui/SpectrumGUIClass.h +++ b/gr-qtgui/include/qtgui/SpectrumGUIClass.h @@ -39,6 +39,10 @@ class SpectrumDisplayForm; #include <vector> #include <string> +/*! + * \brief QWidget class for controlling plotting. + * \ingroup qtgui_blk + */ class SpectrumGUIClass { public: diff --git a/gr-qtgui/include/qtgui/TimeDomainDisplayPlot.h b/gr-qtgui/include/qtgui/TimeDomainDisplayPlot.h index f7e695d51b..4f1883a1cf 100644 --- a/gr-qtgui/include/qtgui/TimeDomainDisplayPlot.h +++ b/gr-qtgui/include/qtgui/TimeDomainDisplayPlot.h @@ -28,6 +28,10 @@ #include <vector> #include <qtgui/DisplayPlot.h> +/*! + * \brief QWidget for displaying time domain plots. + * \ingroup qtgui_blk + */ class TimeDomainDisplayPlot: public DisplayPlot { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/TimeRasterDisplayPlot.h b/gr-qtgui/include/qtgui/TimeRasterDisplayPlot.h index fce22e9df1..9d89e0ffa4 100644 --- a/gr-qtgui/include/qtgui/TimeRasterDisplayPlot.h +++ b/gr-qtgui/include/qtgui/TimeRasterDisplayPlot.h @@ -38,6 +38,10 @@ #include <qwt_compat.h> #endif +/*! + * \brief QWidget for time raster (time vs. time) plots. + * \ingroup qtgui_blk + */ class TimeRasterDisplayPlot: public DisplayPlot { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/WaterfallDisplayPlot.h b/gr-qtgui/include/qtgui/WaterfallDisplayPlot.h index 6659f4f2d6..a31c5b9b21 100644 --- a/gr-qtgui/include/qtgui/WaterfallDisplayPlot.h +++ b/gr-qtgui/include/qtgui/WaterfallDisplayPlot.h @@ -37,6 +37,10 @@ #include <qwt_compat.h> #endif +/*! + * \brief QWidget for displaying waterfall (spectrogram) plots. + * \ingroup qtgui_blk + */ class WaterfallDisplayPlot: public DisplayPlot { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/const_sink_c.h b/gr-qtgui/include/qtgui/const_sink_c.h index b81c53295f..ee92d6fe22 100644 --- a/gr-qtgui/include/qtgui/const_sink_c.h +++ b/gr-qtgui/include/qtgui/const_sink_c.h @@ -34,8 +34,10 @@ namespace gr { /*! * \brief A graphical sink to display the IQ constellation of multiple signals. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink the takes set of a complex * streams and plots them on an IQ constellation plot. */ diff --git a/gr-qtgui/include/qtgui/constellationdisplayform.h b/gr-qtgui/include/qtgui/constellationdisplayform.h index 40cfe8999f..48c70beaed 100644 --- a/gr-qtgui/include/qtgui/constellationdisplayform.h +++ b/gr-qtgui/include/qtgui/constellationdisplayform.h @@ -30,6 +30,10 @@ #include <qtgui/displayform.h> +/*! + * \brief DisplayForm child for managing constellaton (I&Q) plots. + * \ingroup qtgui_blk + */ class ConstellationDisplayForm : public DisplayForm { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/displayform.h b/gr-qtgui/include/qtgui/displayform.h index 47f17ad41d..ac7ee9bf8d 100644 --- a/gr-qtgui/include/qtgui/displayform.h +++ b/gr-qtgui/include/qtgui/displayform.h @@ -33,6 +33,10 @@ #include <qtgui/DisplayPlot.h> #include <qtgui/form_menus.h> +/*! + * \brief Base class for setting up and managing QTGUI plot forms. + * \ingroup qtgui_blk + */ class DisplayForm : public QWidget { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/freq_sink_c.h b/gr-qtgui/include/qtgui/freq_sink_c.h index 79d3f2e8f0..c0b053060c 100644 --- a/gr-qtgui/include/qtgui/freq_sink_c.h +++ b/gr-qtgui/include/qtgui/freq_sink_c.h @@ -34,8 +34,10 @@ namespace gr { /*! * \brief A graphical sink to display multiple signals in frequency. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink the takes set of a complex * streams and plots the PSD. Each signal is plotted with a * different color, and the \a set_title and \a set_color diff --git a/gr-qtgui/include/qtgui/freq_sink_f.h b/gr-qtgui/include/qtgui/freq_sink_f.h index 131801f531..501c377483 100644 --- a/gr-qtgui/include/qtgui/freq_sink_f.h +++ b/gr-qtgui/include/qtgui/freq_sink_f.h @@ -34,8 +34,10 @@ namespace gr { /*! * \brief A graphical sink to display multiple signals in frequency. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink the takes set of a floating * point streams and plots the PSD. Each signal is plotted with a * different color, and the \a set_title and \a set_color diff --git a/gr-qtgui/include/qtgui/freqdisplayform.h b/gr-qtgui/include/qtgui/freqdisplayform.h index 2daba90919..e54b507993 100644 --- a/gr-qtgui/include/qtgui/freqdisplayform.h +++ b/gr-qtgui/include/qtgui/freqdisplayform.h @@ -31,6 +31,10 @@ #include <qtgui/displayform.h> +/*! + * \brief DisplayForm child for managing frequency (PSD) plots. + * \ingroup qtgui_blk + */ class FreqDisplayForm : public DisplayForm { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/plot_raster.h b/gr-qtgui/include/qtgui/plot_raster.h index 5692cc4ba8..2a5159e00e 100644 --- a/gr-qtgui/include/qtgui/plot_raster.h +++ b/gr-qtgui/include/qtgui/plot_raster.h @@ -35,15 +35,16 @@ class QwtColorMap; /*! - \brief A plot item, which displays a time raster. - - A time raster displays threedimenional data, where the 3rd dimension - ( the intensity ) is displayed using colors. The colors are calculated - from the values using a color map. - - \sa QwtRasterData, QwtColorMap -*/ - + * \brief A plot item, which displays a time raster. + * \ingroup qtgui_blk + * + * \details + * A time raster displays threedimenional data, where the 3rd dimension + * (the intensity) is displayed using colors. The colors are calculated + * from the values using a color map. + * + * \sa QwtRasterData, QwtColorMap + */ class PlotTimeRaster: public QwtPlotRasterItem { public: diff --git a/gr-qtgui/include/qtgui/plot_waterfall.h b/gr-qtgui/include/qtgui/plot_waterfall.h index 4c764fd764..ed8edbbd0c 100644 --- a/gr-qtgui/include/qtgui/plot_waterfall.h +++ b/gr-qtgui/include/qtgui/plot_waterfall.h @@ -35,15 +35,16 @@ class QwtColorMap; /*! - \brief A plot item, which displays a waterfall spectrogram - - A waterfall displays threedimenional data, where the 3rd dimension - ( the intensity ) is displayed using colors. The colors are calculated - from the values using a color map. - - \sa QwtRasterData, QwtColorMap -*/ - + * \brief A plot item, which displays a waterfall spectrogram + * \ingroup qtgui_blk + * + * \details + * A waterfall displays threedimenional data, where the 3rd dimension + * (the intensity) is displayed using colors. The colors are calculated + * from the values using a color map. + * + * \sa QwtRasterData, QwtColorMap + */ class PlotWaterfall: public QwtPlotRasterItem { public: diff --git a/gr-qtgui/include/qtgui/sink_c.h b/gr-qtgui/include/qtgui/sink_c.h index 45b980686c..8d8a1e97ab 100644 --- a/gr-qtgui/include/qtgui/sink_c.h +++ b/gr-qtgui/include/qtgui/sink_c.h @@ -35,8 +35,10 @@ namespace gr { /*! * \brief A graphical sink to display freq, spec, time, and const plots. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink the takes a complex stream and * plots it. The default action is to plot the signal as a PSD (FFT), * spectrogram (waterfall), time domain I&Q, and constellation (I diff --git a/gr-qtgui/include/qtgui/sink_f.h b/gr-qtgui/include/qtgui/sink_f.h index c2bed902d9..6a7783db50 100644 --- a/gr-qtgui/include/qtgui/sink_f.h +++ b/gr-qtgui/include/qtgui/sink_f.h @@ -35,8 +35,10 @@ namespace gr { /*! * \brief A graphical sink to display freq, spec, and time. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink the takes a float stream and * plots it. The default action is to plot the signal as a PSD (FFT), * spectrogram (waterfall), and time domain plots. The plots may be diff --git a/gr-qtgui/include/qtgui/time_raster_sink_b.h b/gr-qtgui/include/qtgui/time_raster_sink_b.h index 132ab9715c..083a6a2d24 100644 --- a/gr-qtgui/include/qtgui/time_raster_sink_b.h +++ b/gr-qtgui/include/qtgui/time_raster_sink_b.h @@ -35,8 +35,10 @@ namespace gr { /*! * \brief A graphical sink to display multiple signals on a * time_raster plot. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink that takes in byte * streams and plots a time_raster (spectrogram) plot. * diff --git a/gr-qtgui/include/qtgui/time_raster_sink_f.h b/gr-qtgui/include/qtgui/time_raster_sink_f.h index 7215373bec..07deb25fc0 100644 --- a/gr-qtgui/include/qtgui/time_raster_sink_f.h +++ b/gr-qtgui/include/qtgui/time_raster_sink_f.h @@ -35,8 +35,10 @@ namespace gr { /*! * \brief A graphical sink to display multiple signals on a * time_raster plot. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink that takes set of a floating * point streams and plots a time_raster (spectrogram) plot. * diff --git a/gr-qtgui/include/qtgui/time_sink_c.h b/gr-qtgui/include/qtgui/time_sink_c.h index 82ab27d443..d3234b94bb 100644 --- a/gr-qtgui/include/qtgui/time_sink_c.h +++ b/gr-qtgui/include/qtgui/time_sink_c.h @@ -33,8 +33,10 @@ namespace gr { /*! * \brief A graphical sink to display multiple signals in time. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink the takes set of a complex * streams and plots them in the time domain. For each signal, both * the signal's I and Q parts are plotted, and they are all plotted diff --git a/gr-qtgui/include/qtgui/time_sink_f.h b/gr-qtgui/include/qtgui/time_sink_f.h index 6c0788f715..cf0df05337 100644 --- a/gr-qtgui/include/qtgui/time_sink_f.h +++ b/gr-qtgui/include/qtgui/time_sink_f.h @@ -33,8 +33,10 @@ namespace gr { /*! * \brief A graphical sink to display multiple signals in time. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * 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 diff --git a/gr-qtgui/include/qtgui/timedisplayform.h b/gr-qtgui/include/qtgui/timedisplayform.h index 4df4698e3f..4e216abb0c 100644 --- a/gr-qtgui/include/qtgui/timedisplayform.h +++ b/gr-qtgui/include/qtgui/timedisplayform.h @@ -30,6 +30,10 @@ #include <qtgui/displayform.h> +/*! + * \brief DisplayForm child for managing time domain plots. + * \ingroup qtgui_blk + */ class TimeDisplayForm : public DisplayForm { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/timerasterdisplayform.h b/gr-qtgui/include/qtgui/timerasterdisplayform.h index 8c68c52bca..7d6af9f5dd 100644 --- a/gr-qtgui/include/qtgui/timerasterdisplayform.h +++ b/gr-qtgui/include/qtgui/timerasterdisplayform.h @@ -31,6 +31,10 @@ #include <qtgui/displayform.h> +/*! + * \brief DisplayForm child for managing time raster plots. + * \ingroup qtgui_blk + */ class TimeRasterDisplayForm : public DisplayForm { Q_OBJECT diff --git a/gr-qtgui/include/qtgui/waterfall_sink_c.h b/gr-qtgui/include/qtgui/waterfall_sink_c.h index 5bc921ccb3..060c0f14b6 100644 --- a/gr-qtgui/include/qtgui/waterfall_sink_c.h +++ b/gr-qtgui/include/qtgui/waterfall_sink_c.h @@ -35,8 +35,10 @@ namespace gr { /*! * \brief A graphical sink to display multiple signals on a * waterfall (spectrogram) plot. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink the takes set of a complex * streams and plots a waterfall (spectrogram) plot. * diff --git a/gr-qtgui/include/qtgui/waterfall_sink_f.h b/gr-qtgui/include/qtgui/waterfall_sink_f.h index 98a434e668..a550d3d2d2 100644 --- a/gr-qtgui/include/qtgui/waterfall_sink_f.h +++ b/gr-qtgui/include/qtgui/waterfall_sink_f.h @@ -35,8 +35,10 @@ namespace gr { /*! * \brief A graphical sink to display multiple signals on a * waterfall (spectrogram) plot. + * \ingroup instrumentation_blk * \ingroup qtgui_blk * + * \details * This is a QT-based graphical sink the takes set of a floating * point streams and plots a waterfall (spectrogram) plot. * diff --git a/gr-qtgui/include/qtgui/waterfalldisplayform.h b/gr-qtgui/include/qtgui/waterfalldisplayform.h index 56efe4ed27..00e678bd0c 100644 --- a/gr-qtgui/include/qtgui/waterfalldisplayform.h +++ b/gr-qtgui/include/qtgui/waterfalldisplayform.h @@ -31,6 +31,10 @@ #include <qtgui/displayform.h> +/*! + * \brief DisplayForm child for managing waterfall (spectrogram) plots. + * \ingroup qtgui_blk + */ class WaterfallDisplayForm : public DisplayForm { Q_OBJECT |