summaryrefslogtreecommitdiffstats
path: root/src/sql/kernel/qsqlquery.cpp
diff options
context:
space:
mode:
authorMarc Mutz <[email protected]>2024-10-02 18:46:01 +0200
committerQt Cherry-pick Bot <[email protected]>2024-11-12 13:09:02 +0000
commitb8c9a4c3d12c4f3ec8c00cf8ffb70a454bd0645d (patch)
tree4f7291323b9555b580bce5d794a1aa1c593fd32b /src/sql/kernel/qsqlquery.cpp
parente1f46ee8aefaa051343695b9e2306cf9fa4a2e6b (diff)
Create qdoc macros for C++ class docs 1.3: member-swap(), non-standard 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 this third patch is for documentation that used a non-standard phrasing for documenting member-swap(). By using the macro, the documentation automatically conforms to what the documentation team picks as the \memberswap expansion going forward. As a drive-by, fix doc block indentation to the Qt standard of 4 spaces (only in changed lines), and add a few blank lines where they were missing before. Fixes: QTBUG-129573 Pick-to: 6.7 6.5 6.2 Change-Id: If007602d7690572fcbb848a8d0235416c908cfd2 Reviewed-by: Topi Reiniƶ <[email protected]> Reviewed-by: Ivan Solovev <[email protected]> (cherry picked from commit 82058367923ce164024885854c139ee5e0d89949) Reviewed-by: Qt Cherry-pick Bot <[email protected]>
Diffstat (limited to 'src/sql/kernel/qsqlquery.cpp')
-rw-r--r--src/sql/kernel/qsqlquery.cpp3
1 files changed, 1 insertions, 2 deletions
diff --git a/src/sql/kernel/qsqlquery.cpp b/src/sql/kernel/qsqlquery.cpp
index b1ec8bde935..34f419e92f3 100644
--- a/src/sql/kernel/qsqlquery.cpp
+++ b/src/sql/kernel/qsqlquery.cpp
@@ -263,8 +263,7 @@ QSqlQuery& QSqlQuery::operator=(const QSqlQuery& other)
/*!
\fn void QSqlQuery::swap(QSqlQuery &other) noexcept
\since 6.2
- Swaps \a other to this object. This operation is very
- fast and never fails.
+ \memberswap{query}
*/
/*!