diff options
| author | Jason Hein <jason.j.hein@gmail.com> | 2018-08-31 15:17:40 -0400 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2018-12-17 21:19:32 -0800 |
| commit | e42034982c1d1261ff012bdd04bdf5b88bc4d396 (patch) | |
| tree | 5d082483184f2018f16bd2553dba093d95e0947d | |
| parent | c9fb3b5ef0da673d3f9b4bfcc3a47e6abc0e16c4 (diff) | |
qtgui: Add doxygen for bandwidth msg port to waterfall, frequency sink
This addresses the fix for #1952.
4 files changed, 27 insertions, 7 deletions
diff --git a/gr-qtgui/include/gnuradio/qtgui/freq_sink_c.h b/gr-qtgui/include/gnuradio/qtgui/freq_sink_c.h index 0adc85eda9..c96185da54 100644 --- a/gr-qtgui/include/gnuradio/qtgui/freq_sink_c.h +++ b/gr-qtgui/include/gnuradio/qtgui/freq_sink_c.h @@ -62,12 +62,17 @@ namespace gr { * Message Ports: * * - freq (input): - * Receives a PMT pair: (intern("freq"), double(frequency). + * Receives a PMT pair: (intern("freq"), double(frequency)). * This is used to retune the center frequency of the * display's x-axis. + * + * - bw (input): + * Receives a PMT pair: (intern("bw"), double(bandwidth)). + * This is used to programmatically change the bandwidth of + * of the display's x-axis. * * - freq (output): - * Produces a PMT pair with (intern("freq"), double(frequency). + * Produces a PMT pair with (intern("freq"), double(frequency)). * When a user double-clicks on the display, the block * produces and emits a message containing the frequency of * where on the x-axis the user clicked. This value can be diff --git a/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h b/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h index 0dc1f7700d..5e621a4f82 100644 --- a/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h +++ b/gr-qtgui/include/gnuradio/qtgui/freq_sink_f.h @@ -62,12 +62,17 @@ namespace gr { * Message Ports: * * - freq (input): - * Receives a PMT pair: (intern("freq"), double(frequency). + * Receives a PMT pair: (intern("freq"), double(frequency)). * This is used to retune the center frequency of the * display's x-axis. + * + * - bw (input): + * Receives a PMT pair: (intern("bw"), double(bandwidth)). + * This is used to programmatically change the bandwidth of + * of the display's x-axis. * * - freq (output): - * Produces a PMT pair with (intern("freq"), double(frequency). + * Produces a PMT pair with (intern("freq"), double(frequency)). * When a user double-clicks on the display, the block * produces and emits a message containing the frequency of * where on the x-axis the user clicked. This value can be diff --git a/gr-qtgui/include/gnuradio/qtgui/waterfall_sink_c.h b/gr-qtgui/include/gnuradio/qtgui/waterfall_sink_c.h index 8891529753..d90851e602 100644 --- a/gr-qtgui/include/gnuradio/qtgui/waterfall_sink_c.h +++ b/gr-qtgui/include/gnuradio/qtgui/waterfall_sink_c.h @@ -70,7 +70,12 @@ namespace gr { * Receives a PMT pair: (intern("freq"), double(frequency)). * This is used to retune the center frequency of the * display's x-axis. - * + * + * - bw (input): + * Receives a PMT pair: (intern("bw"), double(bandwidth)). + * This is used to programmatically change the bandwidth of + * of the display's x-axis. + * * - freq (output): * Produces a PMT pair with (intern("freq"), double(frequency)). * When a user double-clicks on the display, the block diff --git a/gr-qtgui/include/gnuradio/qtgui/waterfall_sink_f.h b/gr-qtgui/include/gnuradio/qtgui/waterfall_sink_f.h index e8c659cb09..8f4a88db9c 100644 --- a/gr-qtgui/include/gnuradio/qtgui/waterfall_sink_f.h +++ b/gr-qtgui/include/gnuradio/qtgui/waterfall_sink_f.h @@ -68,12 +68,17 @@ namespace gr { * Message Ports: * * - freq (input): - * Receives a PMT pair: (intern("freq"), double(frequency). + * Receives a PMT pair: (intern("freq"), double(frequency)). * This is used to retune the center frequency of the * display's x-axis. + * + * - bw (input): + * Receives a PMT pair: (intern("bw"), double(bandwidth)). + * This is used to programmatically change the bandwidth of + * of the display's x-axis. * * - freq (output): - * Produces a PMT pair with (intern("freq"), double(frequency). + * Produces a PMT pair with (intern("freq"), double(frequency)). * When a user double-clicks on the display, the block * produces and emits a message containing the frequency of * where on the x-axis the user clicked. This value can be |