1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Hide weak overload template magic from documentation

Browse Source 
Hide the 'template magic' to implement Q_WEAK_OVERLOAD from the
documentation. So far Q_WEAK_OVERLOAD void foo() lead to

  template <typename> void foo()

in the generated documentation, which is arguably confusing to the
uninitiated. And people interested in implementation details & exact
overload resolution will arguably just read the .h files themselves.

Fixes: QTBUG-104851
Change-Id: I5e0b1b337b28e621e6a627241aa8037da0a879a7
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
(cherry picked from commit f71aeea9329faf33d7161e6af88e2a94a35edb9f)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Kai Köhne 2022-07-12 16:07:23 +02:00 committed by Qt Cherry-pick Bot
parent 3483f8d26c
commit 34751307bf
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/global/qt-cpp-defines.qdocconf
View File

@ -123,7 +123,6 @@ Cpp.ignoretokens += \
Q_SVG_EXPORT \ Q_SVG_EXPORT \
Q_TESTLIB_EXPORT \ Q_TESTLIB_EXPORT \
Q_TYPENAME \ Q_TYPENAME \
Q_WEAK_OVERLOAD \
Q_WIDGETS_EXPORT \ Q_WIDGETS_EXPORT \
Q_WINEXTRAS_EXPORT \ Q_WINEXTRAS_EXPORT \
Q_XML_EXPORT \ Q_XML_EXPORT \

6
src/corelib/global/qcompilerdetection.h
View File

@ -1027,7 +1027,11 @@
* "Weak overloads" - makes an otherwise confliciting overload weaker * "Weak overloads" - makes an otherwise confliciting overload weaker
* (by making it a template) * (by making it a template)
*/ */
#define Q_WEAK_OVERLOAD template <typename = void> #ifndef Q_CLANG_QDOC
# define Q_WEAK_OVERLOAD template <typename = void>
#else
# define Q_WEAK_OVERLOAD
#endif
/* /*
* If one wants to add functions that use post-C++17 APIs, one needs to: * If one wants to add functions that use post-C++17 APIs, one needs to: