summaryrefslogtreecommitdiffstats
path: root/doc/global/qt-cpp-defines.qdocconf
diff options
context:
space:
mode:
Diffstat (limited to 'doc/global/qt-cpp-defines.qdocconf')
-rw-r--r--doc/global/qt-cpp-defines.qdocconf14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/global/qt-cpp-defines.qdocconf b/doc/global/qt-cpp-defines.qdocconf
index 0e841e80c9..2f80ca3a68 100644
--- a/doc/global/qt-cpp-defines.qdocconf
+++ b/doc/global/qt-cpp-defines.qdocconf
@@ -18,3 +18,17 @@ excludefiles += \
"*_udev.cpp" \
"*_vxworks.cpp" \
"*_darwin.cpp"
+
+# 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"