1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

QSpan: document slice() and chop()

Browse Source 
Needed to use a weird combination of \c and \a here, as qdoc on
one hand insists that all parameters be documented, and OTOH doesn't
support \a within \c.

Writing anything else than the equivalent code in \c to appease qdoc
would be childish. Equivalent code is the best-possible documentation,
as it leaves no question unanswered.

Pick-to: 6.9
Task-number: QTBUG-131672
Change-Id: I512872360b7eb212001723f2ba12d4c6eac0b6b0
Reviewed-by: Marc Mutz <marc.mutz@qt.io>
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
This commit is contained in:
Marc Mutz 2024-12-05 12:27:39 +01:00 committed by Ivan Solovev
parent 2bdce97480
commit 0afe31fa51
1 changed files with 36 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
src/corelib/tools/qspan.qdoc
View File

@ -642,7 +642,7 @@
These functions do the same thing: subspan() is provided for STL These functions do the same thing: subspan() is provided for STL
compatibility and sliced() is provided for Qt compatibility. compatibility and sliced() is provided for Qt compatibility.
\sa subspan(), first(QSpan<T,E>::size_type), last(QSpan<T,E>::size_type), chopped() \sa subspan(), first(QSpan<T,E>::size_type), last(QSpan<T,E>::size_type), chopped(), slice()
*/ */
/*! /*!
@ -662,7 +662,7 @@
These functions do the same thing: subspan() is provided for STL These functions do the same thing: subspan() is provided for STL
compatibility and sliced() is provided for Qt compatibility. compatibility and sliced() is provided for Qt compatibility.
\sa subspan(), first(QSpan<T,E>::size_type), last(QSpan<T,E>::size_type), chopped() \sa subspan(), first(QSpan<T,E>::size_type), last(QSpan<T,E>::size_type), chopped(), slice()
*/ */
/*! /*!
@ -679,7 +679,40 @@
This span must hold at least \a n elements (\c{E} >= \a n \e{and} size() >= This span must hold at least \a n elements (\c{E} >= \a n \e{and} size() >=
\a n), otherwise the behavior is undefined. \a n), otherwise the behavior is undefined.
\sa subspan(), first(QSpan<T,E>::size_type), last(QSpan<T,E>::size_type), \sa subspan(), first(QSpan<T,E>::size_type), last(QSpan<T,E>::size_type), chop()
*/
/*!
\fn template <typename T, size_t E> void QSpan<T,E>::chop(qsizetype n)
\since 6.9
Same as \c{*this = chopped(}\a{n}\c{)}.
This function is only available on \l{variable-fixed-spans}{variable-sized spans}.
\sa chopped()
*/
/*!
\fn template <typename T, size_t E> void QSpan<T,E>::slice(qsizetype pos)
\since 6.9
Same as \c{*this = sliced(}\a{pos}\c{)}.
This function is only available on \l{variable-fixed-spans}{variable-sized spans}.
\sa sliced()
*/
/*!
\fn template <typename T, size_t E> void QSpan<T,E>::slice(qsizetype pos, qsizetype n)
\since 6.9
Same as \c{*this = sliced(}\a{pos}\c{, }\a{n}\c{)}.
This function is only available on \l{variable-fixed-spans}{variable-sized spans}.
\sa sliced()
*/ */
/*! /*!