aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Wakely <jwakely@redhat.com>2019-05-02 16:44:51 +0100
committerJonathan Wakely <redi@gcc.gnu.org>2019-05-02 16:44:51 +0100
commit69b1efc78725ba6d4bd83585a2ab0f20845a1cb2 (patch)
tree69c6047e88079c3362e35bb0a1b5b39ee8990fde
parent574dfb67be756d323328839a1795b979f88da676 (diff)
downloadgcc-69b1efc78725ba6d4bd83585a2ab0f20845a1cb2.zip
gcc-69b1efc78725ba6d4bd83585a2ab0f20845a1cb2.tar.gz
gcc-69b1efc78725ba6d4bd83585a2ab0f20845a1cb2.tar.bz2
Fix markup for Parallel Mode docs
* include/parallel/settings.h: Fix Doxygen markup. From-SVN: r270804
-rw-r--r--libstdc++-v3/ChangeLog2
-rw-r--r--libstdc++-v3/include/parallel/settings.h19
2 files changed, 11 insertions, 10 deletions
diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog
index e356075..0a01827 100644
--- a/libstdc++-v3/ChangeLog
+++ b/libstdc++-v3/ChangeLog
@@ -1,5 +1,7 @@
2019-05-02 Jonathan Wakely <jwakely@redhat.com>
+ * include/parallel/settings.h: Fix Doxygen markup.
+
* include/ext/pb_ds/detail/bin_search_tree_/*_imps.hpp: Do not define
anything unless PB_DS_CLASS_C_DEC is defined.
* include/ext/pb_ds/detail/binary_heap_/*_imps.hpp: Likewise.
diff --git a/libstdc++-v3/include/parallel/settings.h b/libstdc++-v3/include/parallel/settings.h
index e684acf..d2648da 100644
--- a/libstdc++-v3/include/parallel/settings.h
+++ b/libstdc++-v3/include/parallel/settings.h
@@ -25,12 +25,12 @@
/** @file parallel/settings.h
* @brief Runtime settings and tuning parameters, heuristics to decide
* whether to use parallelized algorithms.
+ *
* This file is a GNU parallel extension to the Standard C++ Library.
*
- * @section parallelization_decision
- * The decision whether to run an algorithm in parallel.
+ * @section parallelization_decision Deciding whether to run an algorithm in parallel.
*
- * There are several ways the user can switch on and __off the parallel
+ * There are several ways the user can switch on and off the parallel
* execution of an algorithm, both at compile- and run-time.
*
* Only sequential execution can be forced at compile-time. This
@@ -60,18 +60,17 @@
* If the algorithm call is not forced to be executed sequentially
* at compile-time, the decision is made at run-time.
* The global variable __gnu_parallel::_Settings::algorithm_strategy
- * is checked. _It is a tristate variable corresponding to:
- *
- * a. force_sequential, meaning the sequential algorithm is executed.
-* b. force_parallel, meaning the parallel algorithm is executed.
-* c. heuristic
+ * is checked. It is a tristate variable corresponding to:
+ * - a. force_sequential, meaning the sequential algorithm is executed.
+ * - b. force_parallel, meaning the parallel algorithm is executed.
+ * - c. heuristic
*
* For heuristic, the parallel algorithm implementation is called
* only if the input size is sufficiently large. For most
* algorithms, the input size is the (combined) length of the input
-* sequence(__s). The threshold can be set by the user, individually
+ * sequence(__s). The threshold can be set by the user, individually
* for each algorithm. The according variables are called
-* gnu_parallel::_Settings::[algorithm]_minimal_n .
+ * gnu_parallel::_Settings::[algorithm]_minimal_n .
*
* For some of the algorithms, there are even more tuning options,
* e. g. the ability to choose from multiple algorithm variants. See