jeirmeister/Cockatrice
1
0
Fork 0
mirror of https://github.com/Cockatrice/Cockatrice.git synced 2026-07-11 21:04:07 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

[Doxygen] \note and \warning

Browse source 
Took 4 minutes

Took 32 seconds
This commit is contained in:
Lukas Brübach 2025-12-05 15:36:11 +01:00
parent 4fe271ab68
commit 2ce254d8bc
2 changed files with 16 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/doxygen/extra-pages/developer_documentation/logging.md
View file

@ -23,14 +23,16 @@ For more information, see [Logging Setup](#logging-setup).
# Log Level and Categories
The default log level for the application is info.
\note The default log level for the application is info.
This means that you should only use qInfo() in production-level code if you are truly sure that this message is
beneficial to end-users and other developers. As a general rule, if your functionality logs to info more than twice in
response to a user interaction, you are advised to consider moving some of these logs down to the debug level.
Furthermore, you are strongly advised to avoid the use of the generic logging macros (e.g. qDebug(), qInfo(), qWarn()).
You should instead use the corresponding category logging macors (qCDebug(), qCInfo(), qCWarn()) and define logging
\warning You are strongly advised to avoid the use of the generic logging macros (e.g. qDebug(), qInfo(), qWarn()).
\note You should instead use the corresponding category logging macros (qCDebug(), qCInfo(), qCWarn()) and define
logging
categories for your log statements.
Example: