diff options
| author | Marc Mutz <marc.mutz@qt.io> | 2025-02-06 08:15:36 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2025-02-28 13:51:18 +0000 |
| commit | b7a67b46e66f161def5bf879f19c66d3fcec1d8b (patch) | |
| tree | feb68ba2f835a8aeced04ad3563230db49ecb011 /src/corelib/kernel/qvariant.cpp | |
| parent | 6f89357f59b507c0dcdc177bc1ecfbbc94d6fed3 (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/kernel/qvariant.cpp')
| -rw-r--r-- | src/corelib/kernel/qvariant.cpp | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp index b1635c9a3c9..f458a634dfb 100644 --- a/src/corelib/kernel/qvariant.cpp +++ b/src/corelib/kernel/qvariant.cpp @@ -547,12 +547,11 @@ QVariant::QVariant(const QVariant &p) value is is initialized with the arguments \c{std::forward<Args>(args)...}. - This overload only participates in overload resolution if \c T can be - constructed from \a args. - This constructor is provided for STL/std::any compatibility. \overload + + \constraints \c T can be constructed from \a args. */ /*! |
