summaryrefslogtreecommitdiffstats
path: root/doc/global/qt-cpp-defines.qdocconf
diff options
context:
space:
mode:
authorMartin Smith <martin.smith@qt.io>2016-09-22 09:48:51 +0200
committerMartin Smith <martin.smith@qt.io>2017-01-07 18:51:29 +0000
commit1885952c234e653f08b520c169f9b2560515f726 (patch)
tree0624551d7d21bd9ab776767e7a1ee538bc430f77 /doc/global/qt-cpp-defines.qdocconf
parent740ff1b881059d18f036c7b021674d0cd11c9014 (diff)
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>
Diffstat (limited to 'doc/global/qt-cpp-defines.qdocconf')
-rw-r--r--doc/global/qt-cpp-defines.qdocconf18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/global/qt-cpp-defines.qdocconf b/doc/global/qt-cpp-defines.qdocconf
index 2f9c873b34..8ac5b70bbb 100644
--- a/doc/global/qt-cpp-defines.qdocconf
+++ b/doc/global/qt-cpp-defines.qdocconf
@@ -219,3 +219,21 @@ Cpp.ignoredirectives += \
# Qt 6: Remove
falsehoods += \
"QT_VERSION >= QT_VERSION_CHECK\\(6,0,0\\)"
+
+
+excludefiles += \
+ "*_p.cpp" \
+ "*_posix.cpp" \
+ "*_android.cpp" \
+ "*_win.cpp" \
+ "*_icu.cpp" \
+ "*_msvc.cpp" \
+ "*_wince.cpp" \
+ "*_winrt.cpp" \
+ "*_mac.cpp" \
+ "*_macx.cpp" \
+ "*_unix.cpp" \
+ "*_udev.cpp" \
+ "*_vxworks.cpp" \
+ "*_darwin.cpp" \
+ "*_x11.cpp"