Skip to content

Commit

Permalink
various documentation enhancements
Browse files Browse the repository at this point in the history
  • Loading branch information
@rabauke
rabauke committed Oct 3, 2021
1 parent c52ef1a commit 970d0f3
Show file tree
Hide file tree
Showing 512 changed files with 8,723 additions and 17,356 deletions.
5 changes: 3 additions & 2 deletions doc/Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -834,7 +834,7 @@ WARN_IF_INCOMPLETE_DOC = YES
# WARN_IF_INCOMPLETE_DOC
# The default value is: NO.

WARN_NO_PARAMDOC = NO
WARN_NO_PARAMDOC = YES

# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
Expand Down Expand Up @@ -2279,7 +2279,8 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = protected=private
PREDEFINED = protected=private \
MPL_DOXYGEN_SHOULD_SKIP_THIS

# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
Expand Down
13 changes: 5 additions & 8 deletions docs/html/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,16 +88,16 @@
<div class="contents">
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory">
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacempl.html" target="_self">mpl</a></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacempl_1_1impl.html" target="_self">impl</a></td><td class="desc"></td></tr>
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>mpl</b></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><b>impl</b></td><td class="desc"></td></tr>
<tr id="row_0_0_0_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1impl_1_1irequest.html" target="_self">irequest</a></td><td class="desc"></td></tr>
<tr id="row_0_0_1_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1impl_1_1prequest.html" target="_self">prequest</a></td><td class="desc"></td></tr>
<tr id="row_0_0_2_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1impl_1_1request.html" target="_self">request</a></td><td class="desc"></td></tr>
<tr id="row_0_0_3_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1impl_1_1request__pool.html" target="_self">request_pool</a></td><td class="desc"></td></tr>
<tr id="row_0_0_4_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1impl_1_1topology__communicator.html" target="_self">topology_communicator</a></td><td class="desc">Base class for communicators with a topology </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1absolute__data.html" target="_self">absolute_data</a></td><td class="desc">Helper class for <a class="el" href="classmpl_1_1heterogeneous__layout.html">heterogeneous_layout</a> and <a class="el" href="namespacempl.html#a6481521478393b302a549178d93b8503">make_absolute</a> </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1absolute__data_3_01const_01_t_01_5_01_4.html" target="_self">absolute_data&lt; const T * &gt;</a></td><td class="desc">Helper class for <a class="el" href="classmpl_1_1heterogeneous__layout.html">heterogeneous_layout</a> and <a class="el" href="classmpl_1_1absolute__data_3_01const_01_t_01_5_01_4.html#a8f6bbd313a30534934c9a4004d1d3f0f">make_absolute</a> </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1absolute__data_3_01_t_01_5_01_4.html" target="_self">absolute_data&lt; T * &gt;</a></td><td class="desc">Helper class for <a class="el" href="classmpl_1_1heterogeneous__layout.html">heterogeneous_layout</a> and <a class="el" href="classmpl_1_1absolute__data_3_01_t_01_5_01_4.html#ac0dc61784adeaeaf328f741871add748">make_absolute</a> </td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1absolute__data.html" target="_self">absolute_data</a></td><td class="desc">Helper class for <a class="el" href="classmpl_1_1heterogeneous__layout.html">heterogeneous_layout</a>, make_absolute(T *x, const layout&lt;T&gt; &amp;l) and make_absolute(const T *x, const layout&lt;T&gt; &amp;l) </td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1absolute__data_3_01const_01_t_01_5_01_4.html" target="_self">absolute_data&lt; const T * &gt;</a></td><td class="desc">Helper class for <a class="el" href="classmpl_1_1heterogeneous__layout.html">heterogeneous_layout</a>, make_absolute(T *x, const layout&lt;T&gt; &amp;l) and <a class="el" href="classmpl_1_1absolute__data_3_01const_01_t_01_5_01_4.html#a8f6bbd313a30534934c9a4004d1d3f0f" title="Helper function for the class heterogeneous_layout.">make_absolute(const T *x, const layout&lt;T&gt; &amp;l)</a> </td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1absolute__data_3_01_t_01_5_01_4.html" target="_self">absolute_data&lt; T * &gt;</a></td><td class="desc">Helper class for <a class="el" href="classmpl_1_1heterogeneous__layout.html">heterogeneous_layout</a>, <a class="el" href="classmpl_1_1absolute__data_3_01_t_01_5_01_4.html#ac0dc61784adeaeaf328f741871add748" title="Helper function for the class heterogeneous_layout.">make_absolute(T *x, const layout&lt;T&gt; &amp;l)</a> and make_absolute(const T *x, const layout&lt;T&gt; &amp;l) </td></tr>
<tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1base__struct__builder.html" target="_self">base_struct_builder</a></td><td class="desc">Base class used to manage information about structures/classes and their public members </td></tr>
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpl_1_1bit__and.html" target="_self">bit_and</a></td><td class="desc">Function object for calculating the bitwise conjunction of two values in reduction operations as <a class="el" href="classmpl_1_1communicator.html#a20c2142532726d3a3f25e4eb3293fd4c" title="Performs a reduction operation over all processes.">communicator::reduce</a> </td></tr>
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmpl_1_1bit__or.html" target="_self">bit_or</a></td><td class="desc">Function object for calculating the bitwise (inclusive) disjunction of two values in reduction operations as <a class="el" href="classmpl_1_1communicator.html#a20c2142532726d3a3f25e4eb3293fd4c" title="Performs a reduction operation over all processes.">communicator::reduce</a> </td></tr>
Expand Down Expand Up @@ -200,9 +200,6 @@
<tr id="row_0_74_0_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1subarray__layout_1_1parameter.html" target="_self">parameter</a></td><td class="desc">Class representing the parameters to characterize a subarray layout </td></tr>
<tr id="row_0_75_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1tag__t.html" target="_self">tag_t</a></td><td class="desc">Class for representing tag parameters in communication operations </td></tr>
<tr id="row_0_76_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmpl_1_1vector__layout.html" target="_self">vector_layout</a></td><td class="desc">Layout representing contiguous storage several objects </td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacestd.html" target="_self">std</a></td><td class="desc"></td></tr>
<tr id="row_1_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1tuple__element_3_01_n_00_01mpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy_01_4.html" target="_self">tuple_element&lt; N, mpl::cartesian_communicator::dimensions::dimension_periodicity_proxy &gt;</a></td><td class="desc"></td></tr>
<tr id="row_1_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstd_1_1tuple__size_3_01mpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy_01_4.html" target="_self">tuple_size&lt; mpl::cartesian_communicator::dimensions::dimension_periodicity_proxy &gt;</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
44 changes: 20 additions & 24 deletions docs/html/annotated_dup.js
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
var annotated_dup =
[
[ "mpl", "namespacempl.html", [
[ "impl", "namespacempl_1_1impl.html", [
[ "irequest", "classmpl_1_1impl_1_1irequest.html", "classmpl_1_1impl_1_1irequest" ],
[ "prequest", "classmpl_1_1impl_1_1prequest.html", "classmpl_1_1impl_1_1prequest" ],
[ "request", "classmpl_1_1impl_1_1request.html", "classmpl_1_1impl_1_1request" ],
[ "request_pool", "classmpl_1_1impl_1_1request__pool.html", "classmpl_1_1impl_1_1request__pool" ],
[ "mpl", null, [
[ "impl", null, [
[ "irequest", "classmpl_1_1impl_1_1irequest.html", null ],
[ "prequest", "classmpl_1_1impl_1_1prequest.html", null ],
[ "request", "classmpl_1_1impl_1_1request.html", null ],
[ "request_pool", "classmpl_1_1impl_1_1request__pool.html", null ],
[ "topology_communicator", "classmpl_1_1impl_1_1topology__communicator.html", "classmpl_1_1impl_1_1topology__communicator" ]
] ],
[ "absolute_data", "classmpl_1_1absolute__data.html", null ],
[ "absolute_data< const T * >", "classmpl_1_1absolute__data_3_01const_01_t_01_5_01_4.html", "classmpl_1_1absolute__data_3_01const_01_t_01_5_01_4" ],
[ "absolute_data< T * >", "classmpl_1_1absolute__data_3_01_t_01_5_01_4.html", "classmpl_1_1absolute__data_3_01_t_01_5_01_4" ],
[ "base_struct_builder", "classmpl_1_1base__struct__builder.html", "classmpl_1_1base__struct__builder" ],
[ "base_struct_builder", "classmpl_1_1base__struct__builder.html", null ],
[ "bit_and", "structmpl_1_1bit__and.html", "structmpl_1_1bit__and" ],
[ "bit_or", "structmpl_1_1bit__or.html", "structmpl_1_1bit__or" ],
[ "bit_xor", "structmpl_1_1bit__xor.html", "structmpl_1_1bit__xor" ],
Expand Down Expand Up @@ -40,8 +40,8 @@ var annotated_dup =
[ "invalid_rank", "classmpl_1_1invalid__rank.html", "classmpl_1_1invalid__rank" ],
[ "invalid_size", "classmpl_1_1invalid__size.html", "classmpl_1_1invalid__size" ],
[ "invalid_tag", "classmpl_1_1invalid__tag.html", "classmpl_1_1invalid__tag" ],
[ "irequest", "classmpl_1_1irequest.html", "classmpl_1_1irequest" ],
[ "irequest_pool", "classmpl_1_1irequest__pool.html", "classmpl_1_1irequest__pool" ],
[ "irequest", "classmpl_1_1irequest.html", null ],
[ "irequest_pool", "classmpl_1_1irequest__pool.html", null ],
[ "iterator_layout", "classmpl_1_1iterator__layout.html", "classmpl_1_1iterator__layout" ],
[ "layout", "classmpl_1_1layout.html", "classmpl_1_1layout" ],
[ "layouts", "classmpl_1_1layouts.html", "classmpl_1_1layouts" ],
Expand All @@ -66,27 +66,23 @@ var annotated_dup =
[ "op_traits< multiplies< T > >", "structmpl_1_1op__traits_3_01multiplies_3_01_t_01_4_01_4.html", null ],
[ "op_traits< plus< T > >", "structmpl_1_1op__traits_3_01plus_3_01_t_01_4_01_4.html", null ],
[ "plus", "structmpl_1_1plus.html", "structmpl_1_1plus" ],
[ "prequest", "classmpl_1_1prequest.html", "classmpl_1_1prequest" ],
[ "prequest_pool", "classmpl_1_1prequest__pool.html", "classmpl_1_1prequest__pool" ],
[ "prequest", "classmpl_1_1prequest.html", null ],
[ "prequest_pool", "classmpl_1_1prequest__pool.html", null ],
[ "ranks", "classmpl_1_1ranks.html", "classmpl_1_1ranks" ],
[ "shift_ranks", "structmpl_1_1shift__ranks.html", "structmpl_1_1shift__ranks" ],
[ "shift_ranks", "structmpl_1_1shift__ranks.html", null ],
[ "status_t", "classmpl_1_1status__t.html", "classmpl_1_1status__t" ],
[ "strided_vector_layout", "classmpl_1_1strided__vector__layout.html", "classmpl_1_1strided__vector__layout" ],
[ "struct_builder", "classmpl_1_1struct__builder.html", "classmpl_1_1struct__builder" ],
[ "struct_builder< std::array< T, N > >", "classmpl_1_1struct__builder_3_01std_1_1array_3_01_t_00_01_n_01_4_01_4.html", "classmpl_1_1struct__builder_3_01std_1_1array_3_01_t_00_01_n_01_4_01_4" ],
[ "struct_builder< std::pair< T1, T2 > >", "classmpl_1_1struct__builder_3_01std_1_1pair_3_01_t1_00_01_t2_01_4_01_4.html", "classmpl_1_1struct__builder_3_01std_1_1pair_3_01_t1_00_01_t2_01_4_01_4" ],
[ "struct_builder< std::tuple< Ts... > >", "classmpl_1_1struct__builder_3_01std_1_1tuple_3_01_ts_8_8_8_01_4_01_4.html", "classmpl_1_1struct__builder_3_01std_1_1tuple_3_01_ts_8_8_8_01_4_01_4" ],
[ "struct_builder< T[N0]>", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_4.html", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_4" ],
[ "struct_builder< T[N0][N1]>", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_4.html", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_4" ],
[ "struct_builder< T[N0][N1][N2]>", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_4.html", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_4" ],
[ "struct_builder< T[N0][N1][N2][N3]>", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_0f_n3_0e_4.html", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_0f_n3_0e_4" ],
[ "struct_builder", "classmpl_1_1struct__builder.html", null ],
[ "struct_builder< std::array< T, N > >", "classmpl_1_1struct__builder_3_01std_1_1array_3_01_t_00_01_n_01_4_01_4.html", null ],
[ "struct_builder< std::pair< T1, T2 > >", "classmpl_1_1struct__builder_3_01std_1_1pair_3_01_t1_00_01_t2_01_4_01_4.html", null ],
[ "struct_builder< std::tuple< Ts... > >", "classmpl_1_1struct__builder_3_01std_1_1tuple_3_01_ts_8_8_8_01_4_01_4.html", null ],
[ "struct_builder< T[N0]>", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_4.html", null ],
[ "struct_builder< T[N0][N1]>", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_4.html", null ],
[ "struct_builder< T[N0][N1][N2]>", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_4.html", null ],
[ "struct_builder< T[N0][N1][N2][N3]>", "classmpl_1_1struct__builder_3_01_t_0f_n0_0e_0f_n1_0e_0f_n2_0e_0f_n3_0e_4.html", null ],
[ "struct_layout", "classmpl_1_1struct__layout.html", "classmpl_1_1struct__layout" ],
[ "subarray_layout", "classmpl_1_1subarray__layout.html", "classmpl_1_1subarray__layout" ],
[ "tag_t", "classmpl_1_1tag__t.html", "classmpl_1_1tag__t" ],
[ "vector_layout", "classmpl_1_1vector__layout.html", "classmpl_1_1vector__layout" ]
] ],
[ "std", "namespacestd.html", [
[ "tuple_element< N, mpl::cartesian_communicator::dimensions::dimension_periodicity_proxy >", "structstd_1_1tuple__element_3_01_n_00_01mpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy_01_4.html", "structstd_1_1tuple__element_3_01_n_00_01mpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy_01_4" ],
[ "tuple_size< mpl::cartesian_communicator::dimensions::dimension_periodicity_proxy >", "structstd_1_1tuple__size_3_01mpl_1_1cartesian__communicator_1_1dimensions_1_1dimension__periodicity__proxy_01_4.html", null ]
] ]
];
Loading

0 comments on commit 970d0f3

Please sign in to comment.