whytofly
/
qt6-bb10
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
qt6-bb10/src/corelib/text
History
Marc Mutz 285bfffc63 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.7 6.5 6.2
Change-Id: Ib494bd218334724b3b43796ba6f71fb52b83aa94
Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
(cherry picked from commit 3ccb4ce781463f1b8e0cb4c9283b3067fe92a32e)
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
 		2024-11-12 13:09:01 +00:00
..
qanystringview.cpp Add max_size() and maxSize() to view types 2024-08-31 08:56:26 +00:00
qanystringview.h QAnyStringView: group the char-ish ctors visually 2024-11-01 04:01:21 +00:00
qbytearray.cpp Create qdoc macros for C++ class docs 1.1: member-swap(), traditional phrasing 2024-11-12 13:09:01 +00:00
qbytearray.h Make Container::max_size() non-static member functions 2024-08-31 08:56:46 +00:00
qbytearrayalgorithms.h QtPrivate: add "defined in" comment to findByteArray/lastIndexOf(~~~, char) 2024-09-05 18:24:12 +00:00
qbytearraylist.cpp
…
qbytearraylist.h
…
qbytearraymatcher.cpp QByteArrayView: use memmem() to search for substrings 2024-06-01 11:27:05 -03:00
qbytearraymatcher.h
…
qbytearrayview.h QByteArrayView: port IsCompatibleByteTypeHelper from is_same-chain to specialization 2024-11-02 02:48:02 +00:00
qbytearrayview.qdoc Add max_size() and maxSize() to view types 2024-08-31 08:56:26 +00:00
qbytedata_p.h
…
qchar.cpp Document the potential widening effect of upper-casing 2024-08-29 18:21:38 +00:00
qchar.h QChar: remove QT_IMPLICIT_QCHAR_CONSTRUCTION opt-in 2024-05-28 19:52:06 +02:00
qcollator.cpp QCollatorSortKey: Rule of Five: add missing move constructor 2024-04-04 18:11:14 +01:00
qcollator.h QCollatorSortKey: don't export the private class destructor 2024-08-12 09:43:38 +00:00
qcollator_icu.cpp
…
qcollator_macx.cpp
…
qcollator_p.h
…
qcollator_posix.cpp
…
qcollator_win.cpp
…
qdoublescanprint_p.h
…
qlatin1stringmatcher.cpp QLatin1StringMatcher: add indexIn(QStringView) overload 2024-05-08 19:22:46 +02:00
qlatin1stringmatcher.h QLatin1StringMatcher: use specialization instead of an is_same chain 2024-09-05 18:24:05 +00:00
qlatin1stringview.h Add max_size() and maxSize() to view types 2024-08-31 08:56:26 +00:00
qlatin1stringview.qdoc Add note about Latin1StringView in UTF-8 source 2024-10-10 07:38:16 +00:00
qlocale.cpp Create qdoc macros for C++ class docs 1.1: member-swap(), traditional phrasing 2024-11-12 13:09:01 +00:00
qlocale.h QLocale: mark equals() noexcept 2024-09-05 15:50:25 +00:00
qlocale.qdoc Update CLDR to v45, adding language Kuvi 2024-07-17 12:57:30 +02:00
qlocale_data_p.h Suppress -Wunused-const-variable in _data_p.h files 2024-09-18 09:32:51 +00:00
qlocale_icu.cpp
…
qlocale_mac.mm Improve fidelity of approximation to CLDR zone representations 2024-04-22 11:58:25 +02:00
qlocale_p.h Remove a duplicate inclusion of qlocale_data_p.h 2024-10-14 17:15:03 +02:00
qlocale_tools.cpp Introduce QT_NO_QSNPRINTF and mark QtCore as qsnprintf-free 2024-08-05 18:22:44 +02:00
qlocale_tools_p.h qlocale_tools_p.h: fix -Wfloat-equal 2024-09-17 16:22:47 +00:00
qlocale_unix.cpp Pass QVariant to QSystemLocale::query() as rvalue reference 2024-04-09 16:41:27 +02:00
qlocale_wasm.cpp Pass QVariant to QSystemLocale::query() as rvalue reference 2024-04-09 16:41:27 +02:00
qlocale_win.cpp Pass QVariant to QSystemLocale::query() as rvalue reference 2024-04-09 16:41:27 +02:00
qregularexpression.cpp Create qdoc macros for C++ class docs 1.1: member-swap(), traditional phrasing 2024-11-12 13:09:01 +00:00
qregularexpression.h QRegularExpression: use modernize comparisons 2024-05-06 16:01:28 +02:00
qstaticlatin1stringmatcher.h QStaticLatin1StringMatcher: add indexIn(QStringView) 2024-05-08 22:05:35 +02:00
qstaticlatin1stringmatcher.qdoc QStaticLatin1StringMatcher: add indexIn(QStringView) 2024-05-08 22:05:35 +02:00
qstring.cpp Create qdoc macros for C++ class docs 1.1: member-swap(), traditional phrasing 2024-11-12 13:09:01 +00:00
qstring.h Make Container::max_size() non-static member functions 2024-08-31 08:56:46 +00:00
qstring_mips_dsp_asm.S
…
qstringalgorithms.h qstringalgorithms: remove unused function declaration 2024-06-07 06:59:22 +00:00
qstringalgorithms_p.h QtCore: fix private header compilation under QT_NO_KEYWORDS 2024-09-15 12:15:34 +00:00
qstringbuilder.cpp
…
qstringbuilder.h QStringBuilder: DRY: use the Concatenable typedef 2024-04-18 14:36:00 -07:00
qstringconverter.cpp QStringConverter/ICU: optimize NUL-termination of codec name 2024-10-11 15:18:14 +00:00
qstringconverter.h QStringEn/Decoder: port (name, Flags) ctors to QAnyStringView 2024-06-12 12:23:41 +00:00
qstringconverter_base.h QStringConverter: port (name, Flags) ctor to QAnyStringView 2024-06-12 12:23:40 +00:00
qstringconverter_p.h Export QLatin1::convertFromUnicode() 2024-05-29 12:27:54 +00:00
qstringfwd.h
…
qstringiterator.qdoc
…
qstringiterator_p.h
…
qstringlist.cpp Doc: Remove usage of defunct QDoc command 2024-08-28 11:39:51 +00:00
qstringlist.h
…
qstringliteral.h
…
qstringmatcher.cpp
…
qstringmatcher.h
…
qstringtokenizer.cpp QStringTokenizer: update docs for a world in which C++17 is required 2024-08-29 04:16:34 +00:00
qstringtokenizer.h QStringTokenizer: clean up Q_STRINGTOKENIZER_USE_SENTINEL 2024-08-29 04:16:40 +00:00
qstringview.cpp QStringView: de-duplicate some API docs 2024-10-23 05:39:23 +00:00
qstringview.h Add max_size() and maxSize() to view types 2024-08-31 08:56:26 +00:00
qt_attribution.json Update CLDR to v45, adding language Kuvi 2024-07-17 12:57:30 +02:00
qtextboundaryfinder.cpp Initialize QTextBoundaryFinder::pos to zero 2024-04-09 16:41:27 +02:00
qtextboundaryfinder.h Initialize QTextBoundaryFinder::pos to zero 2024-04-09 16:41:27 +02:00
qtliterals.qdoc
…
qunicodetables.cpp Revise UCD-generated data files' SPDX headers 2024-04-22 15:22:12 +00:00
qunicodetables_p.h Revise UCD-generated data files' SPDX headers 2024-04-22 15:22:12 +00:00
qunicodetools.cpp
…
qunicodetools_p.h
…
qutf8stringview.h QUtf8StringView: fix missing inline keywords 2024-09-05 12:34:55 +00:00
qutf8stringview.qdoc Add max_size() and maxSize() to view types 2024-08-31 08:56:26 +00:00
qvsnprintf.cpp Introduce QT_NO_QSNPRINTF and mark QtCore as qsnprintf-free 2024-08-05 18:22:44 +02:00