diff options
| author | Marc Mutz <marc.mutz@qt.io> | 2024-10-02 18:46:01 +0200 |
|---|---|---|
| committer | Marc Mutz <marc.mutz@qt.io> | 2024-11-05 17:21:30 +0100 |
| commit | 3ccb4ce781463f1b8e0cb4c9283b3067fe92a32e (patch) | |
| tree | 64b89dd639b19ac2f7a37d40c395e094aed0de53 /src/corelib/tools/qbitarray.cpp | |
| parent | 152cb77f83c6fe192b89cce81329dc57cf00de22 (diff) | |
Create qdoc macros for C++ class docs 1.1: member-swap(), traditional phrasing
We have some patterns for how to document certain functions, but we
also vary the sentences a lot, and you have to look up one
documentation piece and copy it, essentially. If we ever want to
change them, we end up with shotgun surgery.
So apply DRY to the documentation and start a collection of macros to
help with repetitive C++ class documentation tasks.
The first macro is for member-swap(), and the first patch is for
documentation that used the traditional phrasing ("Swaps the X \a
other with this X.").
This doesn't change the documentation, except as follows:
* adds the "very fast and never fails" blurb, if it was missing
* changes the function's argument name to `other`, as required by
the macro.
Task-number: QTBUG-129573
Pick-to: 6.8 6.7 6.5 6.2
Change-Id: Ib494bd218334724b3b43796ba6f71fb52b83aa94
Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
Diffstat (limited to 'src/corelib/tools/qbitarray.cpp')
| -rw-r--r-- | src/corelib/tools/qbitarray.cpp | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/src/corelib/tools/qbitarray.cpp b/src/corelib/tools/qbitarray.cpp index d5643df0250..46e4af37b0f 100644 --- a/src/corelib/tools/qbitarray.cpp +++ b/src/corelib/tools/qbitarray.cpp @@ -496,9 +496,7 @@ quint32 QBitArray::toUInt32(QSysInfo::Endian endianness, bool *ok) const noexcep /*! \fn void QBitArray::swap(QBitArray &other) \since 4.8 - - Swaps bit array \a other with this bit array. This operation is very - fast and never fails. + \memberswap{bit array} */ /*! \fn bool QBitArray::operator==(const QBitArray &lhs, const QBitArray &rhs) |