correct errors in doxygen doc for uninitialized_copy_n

STEllAR-GROUP · Jun 26, 2021 · df2918e · df2918e
1 parent 825e7bd
commit df2918e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 20 deletions.
diff --git a/docs/sphinx/api/public_api.rst b/docs/sphinx/api/public_api.rst
@@ -576,6 +576,9 @@ Functions
 - :cpp:func:`hpx::parallel::v1::uninitialized_value_construct`
 - :cpp:func:`hpx::parallel::v1::uninitialized_value_construct_n`
 
+- :cpp:func:`hpx::ranges::uninitialized_copy`
+- :cpp:func:`hpx::ranges::uninitialized_copy_n`
+
 Header ``hpx/numeric.hpp``
 ==========================
 

diff --git a/libs/parallelism/algorithms/include/hpx/parallel/algorithms/uninitialized_copy.hpp b/libs/parallelism/algorithms/include/hpx/parallel/algorithms/uninitialized_copy.hpp
@@ -101,10 +101,6 @@ namespace hpx {
     /// \note   Complexity: Performs exactly \a count assignments, if
     ///         count > 0, no assignments otherwise.
     ///
-    /// \tparam ExPolicy    The type of the execution policy to use (deduced).
-    ///                     It describes the manner in which the execution
-    ///                     of the algorithm may be parallelized and the manner
-    ///                     in which it executes the assignments.
     /// \tparam FwdIter1      The type of the source iterators used (deduced).
     ///                     This iterator type must meet the requirements of an
     ///                     input iterator.
@@ -115,31 +111,18 @@ namespace hpx {
     ///                     This iterator type must meet the requirements of a
     ///                     forward iterator.
     ///
-    /// \param policy       The execution policy to use for the scheduling of
-    ///                     the iterations.
     /// \param first        Refers to the beginning of the sequence of elements
     ///                     the algorithm will be applied to.
     /// \param count        Refers to the number of elements starting at
     ///                     \a first the algorithm will be applied to.
     /// \param dest         Refers to the beginning of the destination range.
     ///
     /// The assignments in the parallel \a uninitialized_copy_n algorithm
-    /// invoked with an execution policy object of type
-    /// \a sequenced_policy execute in sequential order in the
-    /// calling thread.
-    ///
-    /// The assignments in the parallel \a uninitialized_copy_n algorithm
-    /// invoked with an execution policy object of type
-    /// \a parallel_policy or
-    /// \a parallel_task_policy are permitted to execute in an
-    /// unordered fashion in unspecified threads, and indeterminately sequenced
-    /// within each thread.
+    /// invoked without an execution policy object execute in sequential order
+    /// in the calling thread.
     ///
     /// \returns  The \a uninitialized_copy_n algorithm returns a
-    ///           \a hpx::future<FwdIter2> if the execution policy is of type
-    ///           \a sequenced_task_policy or
-    ///           \a parallel_task_policy and
-    ///           returns \a FwdIter2 otherwise.
+    ///           returns \a FwdIter2.
     ///           The \a uninitialized_copy_n algorithm returns the output
     ///           iterator to the element in the destination range, one past
     ///           the last element copied.