summaryrefslogtreecommitdiffstats
path: root/src/corelib/tools/qsharedpointer.cpp
diff options
context:
space:
mode:
authorMarc Mutz <marc.mutz@qt.io>2025-02-06 08:15:36 +0100
committerTopi Reinio <topi.reinio@qt.io>2025-02-28 13:51:18 +0000
commitb7a67b46e66f161def5bf879f19c66d3fcec1d8b (patch)
treefeb68ba2f835a8aeced04ad3563230db49ecb011 /src/corelib/tools/qsharedpointer.cpp
parent6f89357f59b507c0dcdc177bc1ecfbbc94d6fed3 (diff)
Long live \constraints!
We have divergence in the way we document function, operator and constructor constraints. About half use \note, while the other doesn't. Some say "if and only if" while others say just "participates only if". So add a qdoc macro, \constraints, to semantically mark up these constraints. It expands to a section titled `Constraints`, and uses a predefined sentence (prefix) for constraints. Documentation for constraints is moved to the end of the comment blocks to separate them from the rest of the text. Apply them to all the standard-ish constraint documentation blocks (grepped for "participate"). I didn't look for other, one-off, ways documentation authors may have documented constraints, but I'm also not aware of any. Re-wrap lines only if the result fits into a single line. As a drive-by, drop additional "if"s, as in "only if X and -if- Y" to make the texts work with the `Constraints` section. Fixes: QTBUG-106871 Pick-to: 6.9 6.8 6.5 Change-Id: I18c2f9f734474017264e49165389f8c9c7f34030 Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Diffstat (limited to 'src/corelib/tools/qsharedpointer.cpp')
-rw-r--r--src/corelib/tools/qsharedpointer.cpp6
1 files changed, 2 insertions, 4 deletions
diff --git a/src/corelib/tools/qsharedpointer.cpp b/src/corelib/tools/qsharedpointer.cpp
index 767b7191a17..ae002b1c141 100644
--- a/src/corelib/tools/qsharedpointer.cpp
+++ b/src/corelib/tools/qsharedpointer.cpp
@@ -469,8 +469,7 @@
Move-constructs a QSharedPointer instance, making it point at the same
object that \a other was pointing to.
- This constructor participates in overload resolution only if \c{X*}
- implicitly converts to \c{T*}.
+ \constraints \c{X*} implicitly converts to \c{T*}.
\since 5.6
*/
@@ -480,8 +479,7 @@
Move-assigns \a other to this QSharedPointer instance.
- This assignment operator participates in overload resolution only if \c{X*}
- implicitly converts to \c{T*}.
+ \constraints \c{X*} implicitly converts to \c{T*}.
\since 5.6
*/