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-08 22:49:21 +0100 |
| commit | 82058367923ce164024885854c139ee5e0d89949 (patch) | |
| tree | 1ba22e7a7ac3fa4e815d1721e98771cde4790c75 /src/corelib/serialization/qjsonobject.cpp | |
| parent | 5627e113793df3df24742d7af502a075c2c9e95d (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.8 6.7 6.5 6.2
Change-Id: If007602d7690572fcbb848a8d0235416c908cfd2
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
Diffstat (limited to 'src/corelib/serialization/qjsonobject.cpp')
| -rw-r--r-- | src/corelib/serialization/qjsonobject.cpp | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/src/corelib/serialization/qjsonobject.cpp b/src/corelib/serialization/qjsonobject.cpp index 12d175b8e0d..729119d938d 100644 --- a/src/corelib/serialization/qjsonobject.cpp +++ b/src/corelib/serialization/qjsonobject.cpp @@ -156,8 +156,7 @@ QJsonObject &QJsonObject::operator =(const QJsonObject &other) noexcept = defaul /*! \fn void QJsonObject::swap(QJsonObject &other) \since 5.10 - - Swaps the object \a other with this. This operation is very fast and never fails. + \memberswap{object} */ #ifndef QT_NO_VARIANT |
