diff options
| author | Jacob Gilbert <jacob.gilbert@protonmail.com> | 2021-02-15 15:07:45 -0800 |
|---|---|---|
| committer | Martin Braun <martin@gnuradio.org> | 2021-02-25 04:09:18 -0800 |
| commit | 044b4a3b49b67adfe53e0e88f9adf847a25fad61 (patch) | |
| tree | 4d4e54c46eaddd6c2b63c7693996c307f477bf0e /gr-blocks/include/gnuradio/blocks/message_debug.h | |
| parent | f42166bba7dd3f4df5bc164473fcfe0880d057ef (diff) | |
gr-blocks: deprecate print_pdu port of message_debug block
Having two print ports on this block has confused a number of people,
most recently issue #4191, and combining them is straightforward and
should make this block easier to use. The print_pdu formatting is now
be applied on the print port if the message is a PDU.
Signed-off-by: Jacob Gilbert <jacob.gilbert@protonmail.com>
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/message_debug.h')
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/message_debug.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/message_debug.h b/gr-blocks/include/gnuradio/blocks/message_debug.h index d2cfc59f24..14ded692f4 100644 --- a/gr-blocks/include/gnuradio/blocks/message_debug.h +++ b/gr-blocks/include/gnuradio/blocks/message_debug.h @@ -27,14 +27,13 @@ namespace blocks { * The message debug block is used to capture and print or store * messages as they are received. Any block that generates a * message may connect that message port to one or more of the - * three message input ports of this debug block. The message + * two message input ports of this debug block. The message * ports are: * * \li print: prints the message directly to standard out. * \li store: stores the message in an internal vector. May be * access using the get_message function. - * \li print_pdu: specifically designed to handle formatted PDUs - * (see pdu.h). + * \li print_pdu: DEPRECATED! use print() for all printing */ class BLOCKS_API message_debug : virtual public block { @@ -43,9 +42,10 @@ public: typedef std::shared_ptr<message_debug> sptr; /*! - * \brief Build the message debug block. It takes no parameters - * and has three message ports: print, store, and - * print_pdu. + * \brief Build the message debug block. It takes a single parameter that can be used + * to disable PDU vector printing and has two message ports: print and store. + * + * \param en_uvec Enable PDU Vector Printing. */ static sptr make(bool en_uvec = true); |