diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2018-01-02 14:24:42 +0100 |
|---|---|---|
| committer | André Hartmann <aha_1980@gmx.de> | 2018-01-03 08:33:33 +0000 |
| commit | df9735fc1660dd40730693f08f6e046a5e01deb3 (patch) | |
| tree | 785249eec3f60b14e1b075c524755f4c4141bb53 /src | |
| parent | de7c365028b71e19edcefd20fc0bb6f3e782e40d (diff) | |
Doc: Extend logging documentation
* Add CAN bus logging description
* Add links to QLoggingCategory
* Add an example for Modbus
Change-Id: I9ccca4a90560bc4feeecf1d8fbe5591a90c5e842
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/serialbus/doc/src/qtserialbus-index.qdoc | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/src/serialbus/doc/src/qtserialbus-index.qdoc b/src/serialbus/doc/src/qtserialbus-index.qdoc index 6c91fbf..db9f241 100644 --- a/src/serialbus/doc/src/qtserialbus-index.qdoc +++ b/src/serialbus/doc/src/qtserialbus-index.qdoc @@ -73,14 +73,33 @@ \li Logging Category \li Description \row + \li qt.canbus + \li Enables standard logging inside the \l {Qt CAN Bus} classes + \row + \li qt.canbus.plugins + \li Enables low level logging inside the \l {Qt CAN Bus} plugin classes. + To set logging for a specific plugin, use "qt.canbus.plugins.pluginname". + e.g. "qt.canbus.plugins.socketcan". "qt.canbus.plugins*" affects all plugins. + \row \li qt.modbus - \li Enables standard logging inside the Modbus classes + \li Enables standard logging inside the \l {Qt Modbus} classes \row \li qt.modbus.lowlevel \li Enables low level logging including individual packet content inside - the Modbus classes + the \l {Qt Modbus} classes \endtable + Logging categories can be used to enable additional warning and debug output + for \l QtSerialBus. More detailed information about logging can be found + in \l QLoggingCategory. + + A quick way to enable all \l {Qt Modbus} logging is to add the following line + to the main() function: + + \code + QLoggingCategory::setFilterRules(QStringLiteral("qt.modbus* = true")); + \endcode + \section1 Examples \list |