Skip to content

Commit

Permalink
Fix line break issues that break doxygen code examples (#2103)
Browse files Browse the repository at this point in the history
  • Loading branch information
miscco committed Jul 30, 2024
1 parent ce95739 commit c0cfbd0
Show file tree
Hide file tree
Showing 5 changed files with 120 additions and 107 deletions.
18 changes: 10 additions & 8 deletions thrust/thrust/partition.h
Original file line number Diff line number Diff line change
Expand Up @@ -161,10 +161,11 @@ ForwardIterator partition(ForwardIterator first, ForwardIterator last, Predicate
/*! \p partition reorders the elements <tt>[first, last)</tt> based on the function
* object \p pred applied to a stencil range <tt>[stencil, stencil + (last - first))</tt>,
* such that all of the elements whose corresponding stencil element satisfies \p pred precede all of the elements
* whose corresponding stencil element fails to satisfy it. The postcondition is that, for some iterator \c middle in
* the range <tt>[first, last)</tt>, <tt>pred(*stencil_i)</tt> is \c true for every iterator \c stencil_i in the range
* <tt>[stencil,stencil + (middle - first))</tt> and \c false for every iterator \c stencil_i in the range <tt>[stencil
* + (middle - first), stencil + (last - first))</tt>. The return value of \p stable_partition is \c middle.
* whose corresponding stencil element fails to satisfy it. The postcondition is that, for some iterator \c middle in
* the range <tt>[first, last)</tt>, <tt>pred(*stencil_i)</tt> is \c true for every iterator \c stencil_i in the range
* <tt>[stencil,stencil + (middle - first))</tt> and \c false for every iterator \c stencil_i in the range
* <tt>[stencil + (middle - first), stencil + (last - first))</tt>.
* The return value of \p stable_partition is \c middle.
*
* Note that the relative order of elements in the two reordered sequences is not
* necessarily the same as it was in the original sequence. A different algorithm,
Expand Down Expand Up @@ -229,10 +230,11 @@ _CCCL_HOST_DEVICE ForwardIterator partition(
/*! \p partition reorders the elements <tt>[first, last)</tt> based on the function
* object \p pred applied to a stencil range <tt>[stencil, stencil + (last - first))</tt>,
* such that all of the elements whose corresponding stencil element satisfies \p pred precede all of the elements
* whose corresponding stencil element fails to satisfy it. The postcondition is that, for some iterator \c middle in
* the range <tt>[first, last)</tt>, <tt>pred(*stencil_i)</tt> is \c true for every iterator \c stencil_i in the range
* <tt>[stencil,stencil + (middle - first))</tt> and \c false for every iterator \c stencil_i in the range <tt>[stencil
* + (middle - first), stencil + (last - first))</tt>. The return value of \p stable_partition is \c middle.
* whose corresponding stencil element fails to satisfy it. The postcondition is that, for some iterator \c middle in
* the range <tt>[first, last)</tt>, <tt>pred(*stencil_i)</tt> is \c true for every iterator \c stencil_i in the range
* <tt>[stencil,stencil + (middle - first))</tt> and \c false for every iterator \c stencil_i in the range
* <tt>[stencil + (middle - first), stencil + (last - first))</tt>.
* The return value of \p stable_partition is \c middle.
*
* Note that the relative order of elements in the two reordered sequences is not
* necessarily the same as it was in the original sequence. A different algorithm,
Expand Down
16 changes: 8 additions & 8 deletions thrust/thrust/remove.h
Original file line number Diff line number Diff line change
Expand Up @@ -550,8 +550,8 @@ OutputIterator remove_copy_if(InputIterator first, InputIterator last, OutputIte
* href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
*
* \pre The range <tt>[first, last)</tt> shall not overlap the range <tt>[result, result + (last - first))</tt>.
* \pre The range <tt>[stencil, stencil + (last - first))</tt> shall not overlap the range <tt>[result, result + (last
* - first))</tt>.
* \pre The range <tt>[stencil, stencil + (last - first))</tt> shall not overlap the range
* <tt>[result, result + (last - first))</tt>.
*
* The following code snippet demonstrates how to use \p remove_if to remove
* specific elements from an array of integers using the \p thrust::host execution policy for
Expand Down Expand Up @@ -610,8 +610,8 @@ _CCCL_HOST_DEVICE ForwardIterator remove_if(
* href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
*
* \pre The range <tt>[first, last)</tt> shall not overlap the range <tt>[result, result + (last - first))</tt>.
* \pre The range <tt>[stencil, stencil + (last - first))</tt> shall not overlap the range <tt>[result, result + (last
* - first))</tt>.
* \pre The range <tt>[stencil, stencil + (last - first))</tt> shall not overlap the range
* <tt>[result, result + (last - first))</tt>.
*
* The following code snippet demonstrates how to use \p remove_if to remove
* specific elements from an array of integers.
Expand Down Expand Up @@ -668,8 +668,8 @@ ForwardIterator remove_if(ForwardIterator first, ForwardIterator last, InputIter
* href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output Iterator</a>. \tparam Predicate is a model
* of <a href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
*
* \pre The range <tt>[stencil, stencil + (last - first))</tt> shall not overlap the range <tt>[result, result + (last
* - first))</tt>.
* \pre The range <tt>[stencil, stencil + (last - first))</tt> shall not overlap the range
* <tt>[result, result + (last - first))</tt>.
*
* The following code snippet demonstrates how to use \p remove_copy_if to copy
* a sequence of numbers to an output range while omitting specific elements using the \p thrust::host
Expand Down Expand Up @@ -732,8 +732,8 @@ _CCCL_HOST_DEVICE OutputIterator remove_copy_if(
* href="https://en.cppreference.com/w/cpp/iterator/output_iterator">Output Iterator</a>. \tparam Predicate is a model
* of <a href="https://en.cppreference.com/w/cpp/concepts/predicate">Predicate</a>.
*
* \pre The range <tt>[stencil, stencil + (last - first))</tt> shall not overlap the range <tt>[result, result + (last
* - first))</tt>.
* \pre The range <tt>[stencil, stencil + (last - first))</tt> shall not overlap the range
* <tt>[result, result + (last - first))</tt>.
*
* The following code snippet demonstrates how to use \p remove_copy_if to copy
* a sequence of numbers to an output range while omitting specific elements.
Expand Down
Loading

0 comments on commit c0cfbd0

Please sign in to comment.