String views: de-duplicate API docs

Will be reused in later commits.

Change-Id: I078ad7eb0aac6eb389453d8bc32c414c840bc22e
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This commit is contained in:
Ahmad Samir 2023-10-01 18:24:22 +03:00
parent 26b279eda1
commit 42c4d6c249
5 changed files with 20 additions and 0 deletions

View File

@ -440,8 +440,10 @@ QT_BEGIN_NAMESPACE
Returns a string view containing \a n code points of this string view,
starting at position \a pos.
//! [UB-sliced-index-length]
\note The behavior is undefined when \a pos < 0, \a n < 0,
or \a pos + \a n > size().
//! [UB-sliced-index-length]
\sa first(), last(), chopped(), chop(), truncate(), {Sizes and Sub-Strings}
*/
@ -453,7 +455,9 @@ QT_BEGIN_NAMESPACE
Returns a string view starting at position \a pos in this object,
and extending to its end.
//! [UB-sliced-index-only]
\note The behavior is undefined when \a pos < 0 or \a pos > size().
//! [UB-sliced-index-only]
\sa first(), last(), chopped(), chop(), truncate(), {Sizes and Sub-Strings}
*/

View File

@ -562,8 +562,10 @@
Returns a byte array view that points to \a n bytes of this byte array
view, starting at position \a pos.
//! [UB-sliced-index-length]
\note The behavior is undefined when \a pos < 0, \a n < 0,
or \a pos + \a n > size().
//! [UB-sliced-index-length]
\sa first(), last(), chopped(), chop(), truncate()
*/
@ -574,7 +576,9 @@
Returns a byte array view starting at position \a pos in this object,
and extending to its end.
//! [UB-sliced-index-only]
\note The behavior is undefined when \a pos < 0 or \a pos > size().
//! [UB-sliced-index-only]
\sa first(), last(), chopped(), chop(), truncate()
*/

View File

@ -756,8 +756,10 @@
Returns a Latin-1 string view that points to \a n characters of this
string view, starting at position \a pos.
//! [UB-sliced-index-length]
\note The behavior is undefined when \a pos < 0, \a n < 0,
or \c{pos + n > size()}.
//! [UB-sliced-index-length]
\sa first(), last(), chopped(), chop(), truncate()
*/
@ -769,7 +771,9 @@
Returns a Latin-1 string view starting at position \a pos in this
string view, and extending to its end.
//! [UB-sliced-index-only]
\note The behavior is undefined when \a pos < 0 or \a pos > size().
//! [UB-sliced-index-only]
\sa first(), last(), chopped(), chop(), truncate()
*/

View File

@ -654,8 +654,10 @@ QT_BEGIN_NAMESPACE
Returns a string view that points to \a n characters of this string view,
starting at position \a pos.
//! [UB-sliced-index-length]
\note The behavior is undefined when \a pos < 0, \a n < 0,
or \a pos + \a n > size().
//! [UB-sliced-index-length]
\sa first(), last(), chopped(), chop(), truncate()
*/
@ -668,7 +670,9 @@ QT_BEGIN_NAMESPACE
Returns a string view starting at position \a pos in this object,
and extending to its end.
//! [UB-sliced-index-only]
\note The behavior is undefined when \a pos < 0 or \a pos > size().
//! [UB-sliced-index-only]
\sa first(), last(), chopped(), chop(), truncate()
*/

View File

@ -605,8 +605,10 @@
Returns a string view containing \a n code points of this string view,
starting at position \a pos.
//! [UB-sliced-index-length]
\note The behavior is undefined when \a pos < 0, \a n < 0,
or \a pos + \a n > size().
//! [UB-sliced-index-length]
\sa first(), last(), chopped(), chop(), truncate()
*/
@ -617,7 +619,9 @@
Returns a string view starting at position \a pos in this object,
and extending to its end.
//! [UB-sliced-index-only]
\note The behavior is undefined when \a pos < 0 or \a pos > size().
//! [UB-sliced-index-only]
\sa first(), last(), chopped(), chop(), truncate()
*/