1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
qtbase/doc/global/qt-cpp-defines.qdocconf

35 lines
1.3 KiB
Plaintext
Raw Permalink Normal View History

Doc: Fixed QDoc's navigation mechanism. The HTML pages need to display minimal navigation such as a link to the module landing page or Qt 5's index.html. -new variables available in qdocconf files: navigation.landingpage navigation.homepage navigation.cppclassespage navigation.qmltypespage buildversion The navigation variables are for the new navigation bar. The buildversion variable is to insert documentation build information into the pages. Note about compatibility with Qt Creator docs: The HTML template files for Qt Creator is retained to keep Qt Creator compatible with 5.0.x and 5.1.x. Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-02-19 17:54:54 +01:00
versionsym = QT_VERSION_STR
Clean up qt-cpp-defines.qdocconf Cpp.ignoretokens, Cpp.ignoredirectives, falsehoods are not used anymore by clang based qdoc. Most defines are not needed, either, because clang based qdoc will get these defined by scanning the normal headers. And QDOC, Q_CLANG_QDOC is actually set by qdoc itself. What's left is Q_GUI_LIB, Q_WIDGETS_LIB, which is used in headers modules to make some API conditionally available. Finally, there's QT_KEYPAD_NAVIGATION, which seems to be a Qt 3 thing, but still some documentation depending on it ;) Pick-to: 6.4 Change-Id: Ib9cf0debac8d569cc21271087168a46c0f8635ca Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2022-07-13 19:36:24 +02:00
defines += QT_GUI_LIB \
QT_WIDGETS_LIB \
QT_KEYPAD_NAVIGATION
qdoc: Exclude platform dependent .cpp files clangqdoc can't parse platform dependent source files because they try to include platform dependent system include files. e.g., When clangqdoc is run on macOS, the Windows system include files are not available. This change adds all the platform dependent .cpp files to the excludefiles config variable. This means that qdoc comments are no longer allowed in the excluded files. There shouldn't be any documentation in these files anyway. Platform dependent documentation should be in .qdoc files or in generic .cpp files that do not try to include platform dependent include files. Note that .m and .mm files are excluded programatically in qdoc. Change-Id: I8f93fe9f5604e558b3df8c8cc8ee723010bf885d Reviewed-by: Martin Smith <martin.smith@qt.io>
2016-09-22 09:48:51 +02:00
excludefiles += \
"*_posix.cpp" \
"*_android.cpp" \
"*_win.cpp" \
"*_icu.cpp" \
"*_msvc.cpp" \
"*_wince.cpp" \
"*_winrt.cpp" \
"*_mac.cpp" \
"*_macx.cpp" \
"*_unix.cpp" \
"*_udev.cpp" \
"*_vxworks.cpp" \
Doc: Do not exclude *_x11.cpp files from the documentation build QX11Info class from the Qt X11 Extras module is documented in qx11info_x11.cpp, and it needs to be parsed. Change-Id: I32e8415d93e67dbf16267d4af63979c1db0870b0 Reviewed-by: Andy Shaw <andy.shaw@qt.io>
2017-06-08 14:27:01 +02:00
"*_darwin.cpp"
Doc: Add convenience macros for specifying C++ type ordering information QDoc in Qt 6.7 introduced new commands for C++ type ordering, \compares and \compareswith .. \endcompareswith. The latter is a block command that allows defining a comparison category, a list of types the category applies to, and optional further information inside the command block. Introduce convenience macros that allow a single-word/single-line command to provide the category/types in cases where further information can be omitted. Task-number: QTBUG-104110 Change-Id: I850498c79bd6885906fbc58d0517d33f5a13cf4b Reviewed-by: Luca Di Sera <luca.disera@qt.io> Reviewed-by: Marc Mutz <marc.mutz@qt.io>
2023-11-21 14:38:28 +00:00
# Convenience macros for specifying C++ type ordering in \class documentation
#
# Usage: \stronglyordered
# \stronglyorderedwith {Type1 [Type2 .. TypeN]}
macro.stronglyordered = "\\compares strong"
macro.stronglyorderedwith = "\\compareswith strong \1\n\\endcompareswith"
macro.weaklyordered = "\\compares weak"
macro.weaklyorderedwith = "\\compareswith weak \1\n\\endcompareswith"
macro.partiallyordered = "\\compares partial"
macro.partiallyorderedwith = "\\compareswith partial \1\n\\endcompareswith"
macro.equalitycomparable = "\\compares equality"
macro.equalitycomparablewith = "\\compareswith equality \1\n\\endcompareswith"
Reference in New Issue Copy Permalink