Commit b4db83aa authored by Michal Policht's avatar Michal Policht

Use better workaround for Doxygen and Q_DECLARE_LOGGING_CATEGORY macro.

This macro is not handled properly by Doxygen. Current workaround was to
add semicolon after the macro. This change replaces the need of it by
predefining the macro within Doxygen's PREDEFINED tag. This does not solve
the problem completely, but at least moves workaround to Doxygen domain.
parent d48e5d37
......@@ -6,5 +6,10 @@ documentation appearing after the macro.
Workaround:
Adding semicolon after the macro resolves the issue.
Snippet:
Sulution:
Solved with qbs-cutehmi-doxygen-3.workaround.
......@@ -4,11 +4,7 @@
#include "loggingMacros.hpp"
#include "internal/platform.hpp"
//<CuteHMI-4.workaround target="Doxygen" cause="bug">
// Doxygen does not expand Q_DECLARE_LOGGING_CATEGORY macro properly and messes up documentation appearing after the macro.
// Adding semicolon after the macro resolves the issue.
CUTEHMI_API Q_DECLARE_LOGGING_CATEGORY(cutehmi_2_loggingCategory);
//</CuteHMI-4.workaround>
CUTEHMI_API Q_DECLARE_LOGGING_CATEGORY(cutehmi_2_loggingCategory)
namespace cutehmi {
......
Problem:
Doxygen does not expand Q_DECLARE_LOGGING_CATEGORY macro properly and messes up
documentation appearing after the macro.
Workaround:
Use PREDEFINED tag to substitute real macro definition with empty one.
Snippet:
......@@ -79,7 +79,10 @@ Module {
'EXPAND_ONLY_PREDEF': true,
'PREDEFINED': ['DOXYGEN_WORKAROUND',
'Q_DECLARE_TR_FUNCTIONS()=',
'QT_RCC_MANGLE_NAMESPACE()='
'QT_RCC_MANGLE_NAMESPACE()=',
//<qbs-cutehmi-doxygen-3.workaround target="Doxygen" cause="bug">
'Q_DECLARE_LOGGING_CATEGORY()='
//</qbs-cutehmi-doxygen-3.workaround target="Doxygen" cause="bug">
],
'LAYOUT_FILE': FileInfo.relativePath(product.sourceDirectory, project.sourceDirectory) + 'doc/layout/ProductLayout' + subLevel + '.xml',
'SHOW_FILES': true,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment