diff --git a/cmake/templates/conf.py.in b/cmake/templates/conf.py.in index 2d87e6bcb262..fef94db9a6bd 100644 --- a/cmake/templates/conf.py.in +++ b/cmake/templates/conf.py.in @@ -60,6 +60,22 @@ breathe_projects_source = {} hpx_source_dir = '@HPX_SOURCE_DIR@' hpx_libs_dir = hpx_source_dir + '/libs' hpx_libs = {} +header_info = {} + +def get_info_from_file(source): + title = "None" + header = "None" + + if os.path.exists(source): + with open(source, 'r') as file: + # Search for patterns indicating the title and header + for line in file: + if "/// \page" in line: + title = line.split("/// \page", 1)[-1].strip() + elif "/// \headerfile" in line: + header = line.split("/// \headerfile", 1)[-1].strip() + + return title, header # Scan the libs directory for source files to be included in # the documentation @@ -102,13 +118,20 @@ for lib_dir in os.listdir(hpx_libs_dir): for f in files: if not file_regex.match(f) is None: skip = True - for line in open(subdir_full + '/' + f): + header_file_path = subdir_full + '/' + f + for line in open(header_file_path): if '/// \\' in line: + page_title, include_header = get_info_from_file(header_file_path) skip = False break if skip: continue breathe_projects_source[module][1].append(subdir + '/' + f) + include_prefix = 'include/' + include_index = header_file_path.find(include_prefix) + if include_index != -1: + header = header_file_path[include_index + len(include_prefix):] + header_info[header] = (page_title, include_header) # Generate the rst files for the API documentation api_refs = '' @@ -145,9 +168,11 @@ api_header_file = ''' .. _modules_{0}_api: ------------------------------------------------------------------------------- -{0} +{2} ------------------------------------------------------------------------------- +Defined in header {3} + See :ref:`public_api` for a list of names and headers that are part of the public |hpx| API. @@ -185,8 +210,15 @@ for lib in hpx_libs.keys(): header_name = '{0}_{1}'.format(header_splitted[-3], header_name) header_names.add(header_name) + # Get the info from the dictionary using the header file path + page_title, include_header = header_info.get(header, ("None", "None")) + if page_title == "None": + page_title = header + if include_header == "None": + include_header = header + header_ref = open(basedir + '/' + header_name + '.rst', 'w') - header_ref.write(api_header_file.format(header, module)) + header_ref.write(api_header_file.format(header, module, page_title, include_header)) header_ref.close() header_refs += ' /libs/' + lib + '/' + module + '/api/' + header_name + '.rst\n' module_api_ref.write(api_file) diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/adjacent_difference.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/adjacent_difference.hpp index 08341f0c4991..27d7c543a529 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/adjacent_difference.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/adjacent_difference.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/adjacent_difference.hpp +/// \page hpx::adjacent_difference +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/adjacent_find.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/adjacent_find.hpp index d463802d53b0..9da7bdc02507 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/adjacent_find.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/adjacent_find.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/adjacent_find.hpp +/// \page hpx::adjacent_find +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/all_any_none.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/all_any_none.hpp index 09c840df7328..2b6af6095c44 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/all_any_none.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/all_any_none.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/all_any_none.hpp +/// \page hpx::all_of, hpx::any_of, hpx::none_of +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/copy.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/copy.hpp index 05ba0d7e0f05..22b9bf65200a 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/copy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/copy.hpp @@ -8,6 +8,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/copy.hpp +/// \page hpx::copy, hpx::copy_n, hpx::copy_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/count.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/count.hpp index 2effcf2bf922..7c1c24116764 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/count.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/count.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/count.hpp +/// \page hpx::count, hpx::count_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/destroy.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/destroy.hpp index 85f474ae5100..6dee2424370a 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/destroy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/destroy.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/destroy.hpp +/// \page hpx::destroy, hpx::destroy_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/ends_with.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/ends_with.hpp index 7f6d6ff61938..79bf1356a071 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/ends_with.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/ends_with.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/ends_with.hpp +/// \page hpx::ends_with +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/equal.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/equal.hpp index c2403fc4e57b..fd951af7974f 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/equal.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/equal.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/equal.hpp +/// \page hpx::equal +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/exclusive_scan.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/exclusive_scan.hpp index 389045fe4160..53a305c08cae 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/exclusive_scan.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/exclusive_scan.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/exclusive_scan.hpp +/// \page hpx::exclusive_scan +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/fill.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/fill.hpp index 48de8d441926..97c5302b2957 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/fill.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/fill.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/fill.hpp +/// \page hpx::fill, hpx::fill_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/find.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/find.hpp index 6a1f84a5ffd8..effbc144dfc7 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/find.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/find.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/find.hpp +/// \page hpx::find, hpx::find_if, hpx::find_if_not, hpx::find_end, hpx::find_first_of +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/for_each.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/for_each.hpp index 708c8a74fac5..83688e3bd469 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/for_each.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/for_each.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/for_each.hpp +/// \page hpx::for_each, hpx::for_each_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop.hpp index 814025713d65..bcb1b62c2b4a 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/for_loop.hpp +/// \page hpx::experimental::for_loop, hpx::experimental::for_loop_strided, hpx::experimental::for_loop_n, hpx::experimental::for_loop_n_strided +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop_induction.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop_induction.hpp index 68d2838a5312..d922b2a96504 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop_induction.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop_induction.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/for_loop_induction.hpp +/// \page hpx::experimental::for_loop_induction +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop_reduction.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop_reduction.hpp index e5c768fe3d8f..f9d730dc9fae 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop_reduction.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/for_loop_reduction.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/for_loop_reduction.hpp +/// \page hpx::experimental::for_loop_reduction +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/generate.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/generate.hpp index 5f5f7203a49c..eb3cfdf5075a 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/generate.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/generate.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/generate.hpp +/// \page hpx::generate, hpx::generate_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/includes.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/includes.hpp index 79ff884e02a0..660e33b53c48 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/includes.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/includes.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/includes.hpp +/// \page hpx::includes +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/inclusive_scan.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/inclusive_scan.hpp index 0d6cba28661c..a0d0ce1e3d67 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/inclusive_scan.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/inclusive_scan.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/inclusive_scan.hpp +/// \page hpx::inclusive_scan +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/is_heap.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/is_heap.hpp index d78cab7a11e1..843c1972bf1c 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/is_heap.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/is_heap.hpp @@ -5,6 +5,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::is_heap, hpx::is_heap_until +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/is_partitioned.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/is_partitioned.hpp index 8793a655d666..dc62cfe105e3 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/is_partitioned.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/is_partitioned.hpp @@ -6,6 +6,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::is_partitioned +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/is_sorted.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/is_sorted.hpp index 98efbddb5dcb..a7613d7a8974 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/is_sorted.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/is_sorted.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/is_sorted.hpp +/// \page hpx::is_sorted, hpx::is_sorted_until +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/lexicographical_compare.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/lexicographical_compare.hpp index 7b0ea4f55c5e..11650877977f 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/lexicographical_compare.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/lexicographical_compare.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/lexicographical_compare.hpp +/// \page hpx::lexicographical_compare +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/make_heap.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/make_heap.hpp index 96c7771778b8..82545c2b79ee 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/make_heap.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/make_heap.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/make_heap.hpp +/// \page hpx::make_heap +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/merge.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/merge.hpp index 4925af229784..1e915d247b1e 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/merge.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/merge.hpp @@ -5,6 +5,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::merge, hpx::inplace_merge +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/minmax.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/minmax.hpp index fb86b8bebcf2..1e76ca7cc5a9 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/minmax.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/minmax.hpp @@ -7,6 +7,8 @@ // make inspect happy: hpxinspect:nominmax /// \file parallel/algorithms/minmax.hpp +/// \page hpx::min_element, hpx::max_element, hpx::minmax_element +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/mismatch.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/mismatch.hpp index bbf103f1223d..2ad6ecc019c7 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/mismatch.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/mismatch.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/mismatch.hpp +/// \page hpx::mismatch +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/move.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/move.hpp index c619d33b5b8c..e6c32181f828 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/move.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/move.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/move.hpp +/// \page hpx::move +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/nth_element.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/nth_element.hpp index c5bd2cc845fe..9aa362b99385 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/nth_element.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/nth_element.hpp @@ -8,6 +8,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/nth_element.hpp +/// \page hpx::nth_element +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/partial_sort.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/partial_sort.hpp index 9930511e933f..4954efad6cf2 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/partial_sort.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/partial_sort.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/partial_sort.hpp +/// \page hpx::partial_sort +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/partial_sort_copy.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/partial_sort_copy.hpp index 981986c6380b..52131dcb0f61 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/partial_sort_copy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/partial_sort_copy.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/partial_sort_copy.hpp +/// \page hpx::partial_sort_copy +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/partition.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/partition.hpp index 6a0567138eeb..cce4bb860979 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/partition.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/partition.hpp @@ -6,6 +6,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::partition, hpx::stable_partition, hpx::partition_copy +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/reduce.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/reduce.hpp index 4ee723f36067..d4c7b7ddb663 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/reduce.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/reduce.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/reduce.hpp +/// \page hpx::reduce +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/reduce_by_key.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/reduce_by_key.hpp index 8eb9c29b3383..5c7d1a3b2877 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/reduce_by_key.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/reduce_by_key.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/reduce_by_key.hpp +/// \page hpx::reduce_by_key +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/remove.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/remove.hpp index def8fdd72d5f..d3ad22b2b6fc 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/remove.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/remove.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/remove.hpp +/// \page hpx::remove, hpx::remove_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/remove_copy.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/remove_copy.hpp index c39553c83942..8902d964fbd1 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/remove_copy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/remove_copy.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/remove_copy.hpp +/// \page hpx::remove_copy, hpx::remove_copy_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/replace.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/replace.hpp index ae5fb454f9bc..b07d8c8595cc 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/replace.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/replace.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/replace.hpp +/// \page hpx::replace, hpx::replace_if, hpx::replace_copy, hpx::replace_copy_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/reverse.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/reverse.hpp index 7dcc415fba0e..3e8d8d18137b 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/reverse.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/reverse.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/reverse.hpp +/// \page hpx::reverse, hpx::reverse_copy +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/rotate.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/rotate.hpp index c8d7c422c50f..778a2f6a1a11 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/rotate.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/rotate.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file hpx/parallel/algorithms/rotate.hpp +/// \page hpx::rotate, hpx::rotate_copy +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/search.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/search.hpp index 528eafee35c4..fd01f2957eb6 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/search.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/search.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/search.hpp +/// \page hpx::search, hpx::search_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/set_difference.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/set_difference.hpp index 2aff244133ff..9ad2ce02db34 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/set_difference.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/set_difference.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/set_difference.hpp +/// \page hpx::set_difference +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/set_intersection.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/set_intersection.hpp index 064cceea16f8..95d824f0da3b 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/set_intersection.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/set_intersection.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/set_intersection.hpp +/// \page hpx::set_intersection +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/set_symmetric_difference.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/set_symmetric_difference.hpp index 6d6e24c0d9ad..e719175f3c68 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/set_symmetric_difference.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/set_symmetric_difference.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/set_symmetric_difference.hpp +/// \page hpx::set_symmetric_difference +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/set_union.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/set_union.hpp index 0adb7d7fbce6..70a856148482 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/set_union.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/set_union.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/set_union.hpp +/// \page hpx::set_union +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/shift_left.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/shift_left.hpp index 0983ed244bc0..580dbef96478 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/shift_left.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/shift_left.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/shift_left.hpp +/// \page hpx::shift_left +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/shift_right.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/shift_right.hpp index c626d8ef1fc1..37c17f78d7a0 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/shift_right.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/shift_right.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/shift_right.hpp +/// \page hpx::shift_right +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/sort.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/sort.hpp index 300f0d8da2d3..0095c97e3358 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/sort.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/sort.hpp @@ -8,6 +8,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::sort +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/sort_by_key.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/sort_by_key.hpp index e7340cdb5b66..12ae1beb3bd4 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/sort_by_key.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/sort_by_key.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/sort_by_key.hpp +/// \page hpx::experimental::sort_by_key +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/stable_sort.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/stable_sort.hpp index 12bd086a556c..723ee6ffb8b0 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/stable_sort.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/stable_sort.hpp @@ -6,6 +6,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::stable_sort +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/starts_with.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/starts_with.hpp index cd5a4203ad57..2f8d970f7351 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/starts_with.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/starts_with.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/starts_with.hpp +/// \page hpx::starts_with +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/swap_ranges.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/swap_ranges.hpp index 02aebd3bd04d..166da02c7d0b 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/swap_ranges.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/swap_ranges.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/swap_ranges.hpp +/// \page hpx::swap_ranges +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/transform.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/transform.hpp index 47cef863bc70..427772ceb2e8 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/transform.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/transform.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/transform.hpp +/// \page hpx::transform +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/transform_exclusive_scan.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/transform_exclusive_scan.hpp index 69643f73448c..8745395d3c42 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/transform_exclusive_scan.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/transform_exclusive_scan.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/transform_exclusive_scan.hpp +/// \page hpx::transform_exclusive_scan +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/transform_inclusive_scan.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/transform_inclusive_scan.hpp index 2ff43b08f013..abec64dbca2e 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/transform_inclusive_scan.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/transform_inclusive_scan.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/transform_inclusive_scan.hpp +/// \page hpx::transform_inclusive_scan +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/transform_reduce.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/transform_reduce.hpp index 3ee2c80d1e51..a0494593927e 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/transform_reduce.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/transform_reduce.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/transform_reduce.hpp +/// \page hpx::transform_reduce +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_copy.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_copy.hpp index 013eca34486f..f22ea04aa70b 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_copy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_copy.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/uninitialized_copy.hpp +/// \page hpx::uninitialized_copy, hpx::uninitialized_copy_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_default_construct.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_default_construct.hpp index 47d3967b9dde..e055e2d3ecd9 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_default_construct.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_default_construct.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/uninitialized_default_construct.hpp +/// \page hpx::uninitialized_default_construct, hpx::uninitialized_default_construct_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_fill.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_fill.hpp index 0587f4962566..4807656da44f 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_fill.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_fill.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/uninitialized_fill.hpp +/// \page hpx::uninitialized_fill, hpx::uninitialized_fill_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_move.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_move.hpp index 2749c5773852..6f298236c78b 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_move.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_move.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/uninitialized_move.hpp +/// \page hpx::uninitialized_move, hpx::uninitialized_move_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_relocate.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_relocate.hpp index 9e00159bba60..16584f516410 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_relocate.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_relocate.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/uninitialized_relocate.hpp +/// \page hpx::unititiallized_relocate, hpx::uninitialized_relocate_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_value_construct.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_value_construct.hpp index 790709d40baa..20c1f2a23cf9 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_value_construct.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/uninitialized_value_construct.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/uninitialized_value_construct.hpp +/// \page hpx::uninitialized_value_construct, hpx::uninitialized_value_construct_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/algorithms/unique.hpp b/libs/core/algorithms/include/hpx/parallel/algorithms/unique.hpp index 296942fe2de0..4ede8cc5c462 100644 --- a/libs/core/algorithms/include/hpx/parallel/algorithms/unique.hpp +++ b/libs/core/algorithms/include/hpx/parallel/algorithms/unique.hpp @@ -5,6 +5,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::unique, hpx::unique_copy +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/adjacent_difference.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/adjacent_difference.hpp index e55c13ba7bff..0760c038d0dc 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/adjacent_difference.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/adjacent_difference.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/adjacent_difference.hpp +/// \page hpx::ranges::adjacent_difference +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/adjacent_find.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/adjacent_find.hpp index 1b96a306c45d..90c74e6ddcb3 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/adjacent_find.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/adjacent_find.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/adjacent_find.hpp +/// \page hpx::ranges::adjacent_find +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/all_any_none.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/all_any_none.hpp index 463595ea095c..6c8fbbd77a7a 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/all_any_none.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/all_any_none.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/all_any_none.hpp +/// \page hpx::ranges::all_of, hpx::ranges::any_of, hpx::ranges::none_of +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/copy.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/copy.hpp index 35785c3e415c..e7e78ad7b02d 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/copy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/copy.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/copy.hpp +/// \page hpx::ranges::copy, hpx::ranges::copy_n, hpx::ranges::copy_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/count.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/count.hpp index 46e523a4ffc3..757f27e6583d 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/count.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/count.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/count.hpp +/// \page hpx::ranges::count, hpx::ranges::count_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/destroy.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/destroy.hpp index cd8edab37d28..5ff64c8a0b86 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/destroy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/destroy.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/destroy.hpp +/// \page hpx::ranges::destroy, hpx::ranges::destroy_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/ends_with.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/ends_with.hpp index 5c3f4ad41590..7e0c02608687 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/ends_with.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/ends_with.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/ends_with.hpp +/// \page hpx::ranges::ends_with +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/equal.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/equal.hpp index 68a5bef604a7..fb9d785942c6 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/equal.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/equal.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/equal.hpp +/// \page hpx::ranges::equal +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/exclusive_scan.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/exclusive_scan.hpp index 1d27fdd33ebd..276a687daa9b 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/exclusive_scan.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/exclusive_scan.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/exclusive_scan.hpp +/// \page hpx::ranges::exclusive_scan +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/fill.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/fill.hpp index 628204de01e6..3a966969f63c 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/fill.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/fill.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/fill.hpp +/// \page hpx::ranges::fill, hpx::ranges::fill_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/find.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/find.hpp index 72f36e0c4ffa..59eb0a342056 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/find.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/find.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/find.hpp +/// \page hpx::ranges::find, hpx::ranges::find_if, hpx::ranges::find_if_not, hpx::ranges::find_end, hpx::ranges::find_first_of +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/for_each.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/for_each.hpp index c2b1ec1e11c7..0200f28c9939 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/for_each.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/for_each.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/for_each.hpp +/// \page hpx::ranges::for_each, hpx::ranges::for_each_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/for_loop.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/for_loop.hpp index 9bc7d5b993f4..4b5101f19b04 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/for_loop.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/for_loop.hpp @@ -6,6 +6,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::ranges::experimental::for_loop, hpx::ranges::experimental::for_loop_strided, hpx::ranges::experimental::for_loop_n, hpx::ranges::experimental::for_loop_n_strided +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/generate.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/generate.hpp index ac3bd4532ccd..ab7d2ab27415 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/generate.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/generate.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/generate.hpp +/// \page hpx::ranges::generate, hpx::ranges::generate_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/includes.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/includes.hpp index 628a5b250702..b4d6170aa8b7 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/includes.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/includes.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/includes.hpp +/// \page hpx::ranges::includes +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/inclusive_scan.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/inclusive_scan.hpp index 004c3494a0fc..970151a4f87b 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/inclusive_scan.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/inclusive_scan.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/inclusive_scan.hpp +/// \page hpx::ranges::inclusive_scan +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_heap.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_heap.hpp index 7487dfc4573f..e187f7a2117d 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_heap.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_heap.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/is_heap.hpp +/// \page hpx::ranges::is_heap, hpx::ranges::is_heap_until +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_partitioned.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_partitioned.hpp index d348d0f50040..3dde396c12d8 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_partitioned.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_partitioned.hpp @@ -6,6 +6,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::ranges::is_partitioned +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_sorted.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_sorted.hpp index f72353ebd092..58119b7f1d7b 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_sorted.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/is_sorted.hpp @@ -4,6 +4,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::ranges::is_sorted, hpx::ranges::is_sorted_until +/// \headerfile hpx/algorithm.hpp + #pragma once #if defined(DOXYGEN) diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/lexicographical_compare.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/lexicographical_compare.hpp index 20b9d3efef8e..b82d1564f388 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/lexicographical_compare.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/lexicographical_compare.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/lexicographical_compare.hpp +/// \page hpx::ranges::lexicographical_compare +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/make_heap.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/make_heap.hpp index 27068a98b133..9f5721041f93 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/make_heap.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/make_heap.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/algorithms/make_heap.hpp +/// \page hpx::ranges::make_heap +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/merge.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/merge.hpp index 7d08156dbfde..d8ac5412333d 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/merge.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/merge.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/merge.hpp +/// \page hpx::ranges::merge, hpx::ranges::inplace_merge +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/minmax.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/minmax.hpp index 73794b37bbae..14196eb16f0c 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/minmax.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/minmax.hpp @@ -7,6 +7,8 @@ // make inspect happy: hpxinspect:nominmax /// \file parallel/container_algorithms/minmax.hpp +/// \page hpx::ranges::min_element, hpx::ranges::max_element, hpx::ranges::minmax_element +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/mismatch.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/mismatch.hpp index 1423cc95645e..d49c31b675c5 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/mismatch.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/mismatch.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/mismatch.hpp +/// \page hpx::ranges::mismatch +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/move.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/move.hpp index 0997bd48ca81..5feafeed79a8 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/move.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/move.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/move.hpp +/// \page hpx::ranges::move +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/nth_element.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/nth_element.hpp index 7f4823669c2e..98fe61995eec 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/nth_element.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/nth_element.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/nth_element.hpp +/// \page hpx::ranges::nth_element +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/partial_sort.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/partial_sort.hpp index 19c5f564e52f..287e86add99e 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/partial_sort.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/partial_sort.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/partial_sort.hpp +/// \page hpx::ranges::partial_sort +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/partial_sort_copy.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/partial_sort_copy.hpp index 4901a42faa0c..0adc03f358f5 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/partial_sort_copy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/partial_sort_copy.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/partial_sort_copy.hpp +/// \page hpx::ranges::partial_sort_copy +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/partition.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/partition.hpp index 31b1d96d0d84..7b1950b06c8b 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/partition.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/partition.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/partition.hpp +/// \page hpx::ranges::partition, hpx::ranges::stable_partition, hpx::ranges::partition_copy +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/reduce.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/reduce.hpp index 7eaff3ee92e3..1514ac099640 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/reduce.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/reduce.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/reduce.hpp +/// \page hpx::ranges::reduce +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/remove.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/remove.hpp index 5b32cb2cb339..41eaebbc4519 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/remove.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/remove.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/remove.hpp +/// \page hpx::ranges::remove, hpx::ranges::remove_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/remove_copy.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/remove_copy.hpp index 95a38a26def8..ea276546b460 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/remove_copy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/remove_copy.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/remove_copy.hpp +/// \page hpx::ranges::remove_copy, hpx::ranges::remove_copy_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/replace.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/replace.hpp index d959c63e7053..fdfffa6b01d0 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/replace.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/replace.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/replace.hpp +/// \page hpx::ranges::replace, hpx::ranges::replace_if, hpx::ranges::replace_copy, hpx::ranges::replace_copy_if +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/reverse.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/reverse.hpp index b77592f39ba3..b68ceb452e51 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/reverse.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/reverse.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/reverse.hpp +/// \page hpx::ranges::reverse, hpx::ranges::reverse_copy +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/rotate.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/rotate.hpp index 265dc93b71e1..3ca7c7f91225 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/rotate.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/rotate.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/rotate.hpp +/// \page hpx::ranges::rotate, hpx::ranges::rotate_copy +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/search.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/search.hpp index b4cd3d8524b8..66a579bbee8e 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/search.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/search.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/search.hpp +/// \page hpx::ranges::search, hpx::ranges::search_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_difference.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_difference.hpp index 930437b71393..f5624e11d02e 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_difference.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_difference.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/set_difference.hpp +/// \page hpx::ranges::set_difference +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_intersection.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_intersection.hpp index 4f899b6e77ba..de964a803078 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_intersection.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_intersection.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/set_intersection.hpp +/// \page hpx::ranges::set_intersection +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_symmetric_difference.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_symmetric_difference.hpp index 6d930414f21b..e3fde50f805a 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_symmetric_difference.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_symmetric_difference.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/set_symmetric_difference.hpp +/// \page hpx::ranges::set_symmetric_difference +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_union.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_union.hpp index 846b5e21d383..38545bbfdc6e 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_union.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/set_union.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/set_union.hpp +/// \page hpx::ranges::set_union +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/shift_left.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/shift_left.hpp index 4988e3049519..2fd83eeb57b1 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/shift_left.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/shift_left.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/shift_left.hpp +/// \page hpx::ranges::shift_left +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/shift_right.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/shift_right.hpp index f3913408d77f..9c1703449f97 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/shift_right.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/shift_right.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/shift_right.hpp +/// \page hpx::ranges::shift_right +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/sort.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/sort.hpp index 54d1aad17422..41c58fd49492 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/sort.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/sort.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/sort.hpp +/// \page hpx::ranges::sort +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/stable_sort.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/stable_sort.hpp index 8ca1fca9abc8..788fa7ec8090 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/stable_sort.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/stable_sort.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/stable_sort.hpp +/// \page hpx::ranges::stable_sort +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/starts_with.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/starts_with.hpp index 7eb73c252fe0..819116215c77 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/starts_with.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/starts_with.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/starts_with.hpp +/// \page hpx::ranges::starts_with +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/swap_ranges.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/swap_ranges.hpp index cee3931584d1..a8f6ee8861b3 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/swap_ranges.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/swap_ranges.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/swap_ranges.hpp +/// \page hpx::ranges::swap_ranges +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform.hpp index 32488ad8c9fa..3078d96715b2 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/transform.hpp +/// \page hpx::ranges::transform +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_exclusive_scan.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_exclusive_scan.hpp index e249da9a0d64..8a252c99ef5e 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_exclusive_scan.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_exclusive_scan.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/transform_exclusive_scan.hpp +/// \page hpx::ranges::transform_exclusive_scan +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_inclusive_scan.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_inclusive_scan.hpp index 3081fafd9c98..8878156e39a6 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_inclusive_scan.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_inclusive_scan.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/transform_inclusive_scan.hpp +/// \page hpx::ranges::transform_inclusive_scan +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_reduce.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_reduce.hpp index 55b1fe40f9d5..b49f50233bf9 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_reduce.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/transform_reduce.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/transform_reduce.hpp +/// \page hpx::ranges::transform_reduce +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_copy.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_copy.hpp index d0e81468a576..d6305cc5540e 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_copy.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_copy.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/uninitialized_copy.hpp +/// \page hpx::ranges::uninitialized_copy, hpx::ranges::uninitialized_copy_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_default_construct.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_default_construct.hpp index 4733f6d4022b..1731862070fa 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_default_construct.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_default_construct.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/uninitialized_default_construct.hpp +/// \page hpx::ranges::uninitialized_default_construct, hpx::ranges::uninitialized_default_construct_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_fill.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_fill.hpp index 90af2bf7385b..25f03f3b62d1 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_fill.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_fill.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/uninitialized_fill.hpp +/// \page hpx::ranges::uninitialized_fill, hpx::ranges::uninitialized_fill_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_move.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_move.hpp index 2838516e15b2..a042966e3273 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_move.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_move.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/uninitialized_move.hpp +/// \page hpx::ranges::uninitialized_move, hpx::ranges::uninitialized_move_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_value_construct.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_value_construct.hpp index 1f73f242aed6..08fde08118bd 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_value_construct.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/uninitialized_value_construct.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/uninitialized_value_construct.hpp +/// \page hpx::ranges::uninitialized_value_construct, hpx::ranges::uninitialized_value_construct_n +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/algorithms/include/hpx/parallel/container_algorithms/unique.hpp b/libs/core/algorithms/include/hpx/parallel/container_algorithms/unique.hpp index 3a62e57e0c6e..97709e3685c3 100644 --- a/libs/core/algorithms/include/hpx/parallel/container_algorithms/unique.hpp +++ b/libs/core/algorithms/include/hpx/parallel/container_algorithms/unique.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/container_algorithms/unique.hpp +/// \page hpx::ranges::unique, hpx::ranges::unique_copy +/// \headerfile hpx/algorithm.hpp #pragma once diff --git a/libs/core/assertion/include/hpx/modules/assertion.hpp b/libs/core/assertion/include/hpx/modules/assertion.hpp index 79e575f6b1b5..e5d2ca7d1fae 100644 --- a/libs/core/assertion/include/hpx/modules/assertion.hpp +++ b/libs/core/assertion/include/hpx/modules/assertion.hpp @@ -10,6 +10,9 @@ // hpxinspect:noinclude:HPX_ASSERT_MSG // hpxinspect:noassert_macro +/// \page HPX_ASSERT, HPX_ASSERT_MSG +/// \headerfile hpx/assert.hpp + #pragma once #include diff --git a/libs/core/datastructures/include/hpx/datastructures/any.hpp b/libs/core/datastructures/include/hpx/datastructures/any.hpp index de0113f5a998..8063996ad79d 100644 --- a/libs/core/datastructures/include/hpx/datastructures/any.hpp +++ b/libs/core/datastructures/include/hpx/datastructures/any.hpp @@ -14,6 +14,8 @@ ==============================================================================*/ /// \file any.hpp +/// \page hpx::any_nonser. hpx::bad_any_cast, hpx::unique_any_nonser, hpx::any_cast, hpx::make_any_nonser, hpx::make_unique_any_nonser +/// \headerfile hpx/any.hpp #pragma once diff --git a/libs/core/datastructures/include/hpx/datastructures/serialization/serializable_any.hpp b/libs/core/datastructures/include/hpx/datastructures/serialization/serializable_any.hpp index d8430b3dc164..c47872725d23 100644 --- a/libs/core/datastructures/include/hpx/datastructures/serialization/serializable_any.hpp +++ b/libs/core/datastructures/include/hpx/datastructures/serialization/serializable_any.hpp @@ -14,6 +14,8 @@ ==============================================================================*/ /// \file serializable_any.hpp +/// \page hpx::any, hpx::make_any +/// \headerfile hpx/any.hpp #pragma once diff --git a/libs/core/errors/include/hpx/errors/exception.hpp b/libs/core/errors/include/hpx/errors/exception.hpp index e987046037ab..bb381dadf2d3 100644 --- a/libs/core/errors/include/hpx/errors/exception.hpp +++ b/libs/core/errors/include/hpx/errors/exception.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file exception.hpp +/// \page hpx::exception +/// \headerfile hpx/exception.hpp #pragma once diff --git a/libs/core/errors/include/hpx/errors/throw_exception.hpp b/libs/core/errors/include/hpx/errors/throw_exception.hpp index f1e94b232532..78c4f6ab6e1e 100644 --- a/libs/core/errors/include/hpx/errors/throw_exception.hpp +++ b/libs/core/errors/include/hpx/errors/throw_exception.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file throw_exception.hpp +/// \page HPX_THROW_EXCEPTION, HPX_THROWS_IF +/// \headerfile hpx/exception.hpp #pragma once diff --git a/libs/core/execution/include/hpx/execution/executors/auto_chunk_size.hpp b/libs/core/execution/include/hpx/execution/executors/auto_chunk_size.hpp index eda025f53c52..c742f600c00f 100644 --- a/libs/core/execution/include/hpx/execution/executors/auto_chunk_size.hpp +++ b/libs/core/execution/include/hpx/execution/executors/auto_chunk_size.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/executors/auto_chunk_size.hpp +/// \page hpx::execution::experimental::auto_chunk_size +/// \headerfile hpx/execution.hpp #pragma once diff --git a/libs/core/execution/include/hpx/execution/executors/dynamic_chunk_size.hpp b/libs/core/execution/include/hpx/execution/executors/dynamic_chunk_size.hpp index 4fa555ccc230..cc833aec3020 100644 --- a/libs/core/execution/include/hpx/execution/executors/dynamic_chunk_size.hpp +++ b/libs/core/execution/include/hpx/execution/executors/dynamic_chunk_size.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/executors/dynamic_chunk_size.hpp +/// \page hpx::execution::experimental::dynamic_chunk_size +/// \headerfile hpx/execution.hpp #pragma once diff --git a/libs/core/execution/include/hpx/execution/executors/guided_chunk_size.hpp b/libs/core/execution/include/hpx/execution/executors/guided_chunk_size.hpp index 31c7de83ffe8..e0d025fd1e32 100644 --- a/libs/core/execution/include/hpx/execution/executors/guided_chunk_size.hpp +++ b/libs/core/execution/include/hpx/execution/executors/guided_chunk_size.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/executors/guided_chunk_size.hpp +/// \page hpx::execution::experimental::guided_chunk_size +/// \headerfile hpx/execution.hpp #pragma once diff --git a/libs/core/execution/include/hpx/execution/executors/num_cores.hpp b/libs/core/execution/include/hpx/execution/executors/num_cores.hpp index ceb280d31748..dc00f888667b 100644 --- a/libs/core/execution/include/hpx/execution/executors/num_cores.hpp +++ b/libs/core/execution/include/hpx/execution/executors/num_cores.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/executors/numcores.hpp +/// \page hpx::execution::experimental::num_cores +/// \headerfile hpx/execution.hpp #pragma once diff --git a/libs/core/execution/include/hpx/execution/executors/persistent_auto_chunk_size.hpp b/libs/core/execution/include/hpx/execution/executors/persistent_auto_chunk_size.hpp index 775a9de7fa38..b0906c259f9a 100644 --- a/libs/core/execution/include/hpx/execution/executors/persistent_auto_chunk_size.hpp +++ b/libs/core/execution/include/hpx/execution/executors/persistent_auto_chunk_size.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/executors/persistent_auto_chunk_size.hpp +/// \page hpx::execution::experimental::persistent_auto_chunk_size +/// \headerfile hpx/execution.hpp #pragma once diff --git a/libs/core/execution/include/hpx/execution/executors/static_chunk_size.hpp b/libs/core/execution/include/hpx/execution/executors/static_chunk_size.hpp index 2f42b56508be..1d921a9d5a9e 100644 --- a/libs/core/execution/include/hpx/execution/executors/static_chunk_size.hpp +++ b/libs/core/execution/include/hpx/execution/executors/static_chunk_size.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file parallel/executors/static_chunk_size.hpp +/// \page hpx::execution::experimental::static_chunk_size +/// \headerfile hpx/execution.hpp #pragma once diff --git a/libs/core/executors/include/hpx/executors/execution_policy.hpp b/libs/core/executors/include/hpx/executors/execution_policy.hpp index e6ce801008fb..dcae07c4c57b 100644 --- a/libs/core/executors/include/hpx/executors/execution_policy.hpp +++ b/libs/core/executors/include/hpx/executors/execution_policy.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file hpx/execution/execution_policy.hpp +/// \page hpx::execution::seq, hpx::execution::par, hpx::execution::par_unseq, hpx::execution::task, hpx::execution::sequenced_policy, hpx::execution::parallel_policy, hpx::execution::parallel_unsequenced_policy, hpx::execution::sequenced_task_policy, hpx::execution::parallel_task_policy +/// \headerfile hpx/execution.hpp #pragma once diff --git a/libs/core/functional/include/hpx/functional/bind.hpp b/libs/core/functional/include/hpx/functional/bind.hpp index 9e5699cb6939..8d67711e841c 100644 --- a/libs/core/functional/include/hpx/functional/bind.hpp +++ b/libs/core/functional/include/hpx/functional/bind.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file bind.hpp +/// \page hpx::bind, hpx::placeholders::_1, hpx::placeholders::_2, ..., hpx::placeholders::_9 +/// \headerfile hpx/functional.hpp #pragma once diff --git a/libs/core/functional/include/hpx/functional/bind_back.hpp b/libs/core/functional/include/hpx/functional/bind_back.hpp index b64f4f0422a2..0ce71ca7d0ce 100644 --- a/libs/core/functional/include/hpx/functional/bind_back.hpp +++ b/libs/core/functional/include/hpx/functional/bind_back.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file bind_back.hpp +/// \page hpx::bind_back +/// \headerfile hpx/functional.hpp #pragma once diff --git a/libs/core/functional/include/hpx/functional/bind_front.hpp b/libs/core/functional/include/hpx/functional/bind_front.hpp index 3e16aac29ec7..b4601317a1a7 100644 --- a/libs/core/functional/include/hpx/functional/bind_front.hpp +++ b/libs/core/functional/include/hpx/functional/bind_front.hpp @@ -6,6 +6,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file bind_front.hpp +/// \page hpx::bind_front +/// \headerfile hpx/functional.hpp #pragma once diff --git a/libs/core/functional/include/hpx/functional/function.hpp b/libs/core/functional/include/hpx/functional/function.hpp index 00ae082a2cea..ddb4f5c23ecb 100644 --- a/libs/core/functional/include/hpx/functional/function.hpp +++ b/libs/core/functional/include/hpx/functional/function.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file function.hpp +/// \page hpx::function +/// \headerfile hpx/functional.hpp #pragma once diff --git a/libs/core/functional/include/hpx/functional/function_ref.hpp b/libs/core/functional/include/hpx/functional/function_ref.hpp index 3b9a9fdd629b..9007c2036d5c 100644 --- a/libs/core/functional/include/hpx/functional/function_ref.hpp +++ b/libs/core/functional/include/hpx/functional/function_ref.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file function_ref.hpp +/// \page hpx::function_ref +/// \headerfile hpx/functional.hpp #pragma once diff --git a/libs/core/functional/include/hpx/functional/invoke.hpp b/libs/core/functional/include/hpx/functional/invoke.hpp index 5111ff919c84..83799872ba53 100644 --- a/libs/core/functional/include/hpx/functional/invoke.hpp +++ b/libs/core/functional/include/hpx/functional/invoke.hpp @@ -4,6 +4,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::invoke +/// \headerfile hpx/functional.hpp + #pragma once #include diff --git a/libs/core/functional/include/hpx/functional/invoke_fused.hpp b/libs/core/functional/include/hpx/functional/invoke_fused.hpp index 7c07ba584d72..e916a0bdacf5 100644 --- a/libs/core/functional/include/hpx/functional/invoke_fused.hpp +++ b/libs/core/functional/include/hpx/functional/invoke_fused.hpp @@ -4,6 +4,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::invoke_fused, hpx::invoke_fused_r +/// \headerfile hpx/functional.hpp + #pragma once #include diff --git a/libs/core/functional/include/hpx/functional/mem_fn.hpp b/libs/core/functional/include/hpx/functional/mem_fn.hpp index bc004630f905..1ea92d0a1fdc 100644 --- a/libs/core/functional/include/hpx/functional/mem_fn.hpp +++ b/libs/core/functional/include/hpx/functional/mem_fn.hpp @@ -4,6 +4,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::mem_fn +/// \headerfile hpx/functional.hpp + #pragma once #include diff --git a/libs/core/functional/include/hpx/functional/move_only_function.hpp b/libs/core/functional/include/hpx/functional/move_only_function.hpp index 42e102714883..8d1bbdd11b4a 100644 --- a/libs/core/functional/include/hpx/functional/move_only_function.hpp +++ b/libs/core/functional/include/hpx/functional/move_only_function.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file move_only_function.hpp +/// \page hpx::move_only_function +/// \headerfile hpx/functional.hpp #pragma once diff --git a/libs/core/functional/include/hpx/functional/traits/is_bind_expression.hpp b/libs/core/functional/include/hpx/functional/traits/is_bind_expression.hpp index fc50075c866c..f3604cf7b8c8 100644 --- a/libs/core/functional/include/hpx/functional/traits/is_bind_expression.hpp +++ b/libs/core/functional/include/hpx/functional/traits/is_bind_expression.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file is_bind_expression.hpp +/// \page hpx::is_bind_expression +/// \headerfile hpx/functional.hpp #pragma once diff --git a/libs/core/functional/include/hpx/functional/traits/is_placeholder.hpp b/libs/core/functional/include/hpx/functional/traits/is_placeholder.hpp index 7b63e15a9f53..ddc056960ab2 100644 --- a/libs/core/functional/include/hpx/functional/traits/is_placeholder.hpp +++ b/libs/core/functional/include/hpx/functional/traits/is_placeholder.hpp @@ -7,6 +7,8 @@ // make inspect happy: hpxinspect:nodeprecatedname:boost::is_placeholder /// \file is_placeholder.hpp +/// \page hpx::is_placeholder +/// \headerfile hpx/functional.hpp #pragma once diff --git a/libs/core/synchronization/include/hpx/synchronization/barrier.hpp b/libs/core/synchronization/include/hpx/synchronization/barrier.hpp index 39b9f492cc3b..52f29227cf35 100644 --- a/libs/core/synchronization/include/hpx/synchronization/barrier.hpp +++ b/libs/core/synchronization/include/hpx/synchronization/barrier.hpp @@ -7,6 +7,9 @@ // // The algorithm was taken from http://locklessinc.com/articles/barriers/ +/// \page hpx::barrier +/// \headerfile hpx/barrier.hpp + #pragma once #include diff --git a/libs/core/synchronization/include/hpx/synchronization/condition_variable.hpp b/libs/core/synchronization/include/hpx/synchronization/condition_variable.hpp index 420b2da18efc..5c142ce03596 100644 --- a/libs/core/synchronization/include/hpx/synchronization/condition_variable.hpp +++ b/libs/core/synchronization/include/hpx/synchronization/condition_variable.hpp @@ -7,6 +7,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file condition_variable.hpp +/// \page hpx::condition_variable, hpx::condition_variable_any, hpx::cv_status +/// \headerfile hpx/condition_variable.hpp #pragma once diff --git a/libs/core/threading_base/include/hpx/threading_base/annotated_function.hpp b/libs/core/threading_base/include/hpx/threading_base/annotated_function.hpp index b212ff01625a..67fe89179cce 100644 --- a/libs/core/threading_base/include/hpx/threading_base/annotated_function.hpp +++ b/libs/core/threading_base/include/hpx/threading_base/annotated_function.hpp @@ -4,6 +4,9 @@ // Distributed under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +/// \page hpx::annotated_function +/// \headerfile hpx/functional.hpp + #pragma once #include diff --git a/libs/core/threading_base/include/hpx/threading_base/scoped_annotation.hpp b/libs/core/threading_base/include/hpx/threading_base/scoped_annotation.hpp index 4d7cbc5271c7..b8c2760631d3 100644 --- a/libs/core/threading_base/include/hpx/threading_base/scoped_annotation.hpp +++ b/libs/core/threading_base/include/hpx/threading_base/scoped_annotation.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file scoped_annotation.hpp +/// \page hpx::scoped_annotation +/// \headerfile hpx/functional.hpp #pragma once @@ -42,7 +44,7 @@ namespace hpx { explicit constexpr scoped_annotation(char const*) noexcept {} template - explicit HPX_HOST_DEVICE constexpr scoped_annotation(F&&) noexcept + explicit HPX_HOST_DEVICE constexpr scoped_annotation(F &&) noexcept { } @@ -83,7 +85,7 @@ namespace hpx { template , std::string>>> - explicit scoped_annotation(F&& f) + explicit scoped_annotation(F && f) : task_(thread_domain_, hpx::traits::get_function_annotation_itt>::call( f)) @@ -158,7 +160,7 @@ namespace hpx { template , std::string>>> - explicit scoped_annotation(F&& f) + explicit scoped_annotation(F && f) { auto const* self = hpx::threads::get_self_ptr(); if (self != nullptr) @@ -201,7 +203,8 @@ namespace hpx { explicit constexpr scoped_annotation(char const* /*name*/) noexcept {} template - explicit HPX_HOST_DEVICE constexpr scoped_annotation(F&& /*f*/) noexcept + explicit HPX_HOST_DEVICE constexpr scoped_annotation( + F && /*f*/) noexcept { } diff --git a/libs/core/timing/include/hpx/timing/high_resolution_clock.hpp b/libs/core/timing/include/hpx/timing/high_resolution_clock.hpp index 1dd81ea178bd..0ba49242042f 100644 --- a/libs/core/timing/include/hpx/timing/high_resolution_clock.hpp +++ b/libs/core/timing/include/hpx/timing/high_resolution_clock.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file high_resolution_clock.hpp +/// \page hpx::chrono::high_resolution_clock +/// \headerfile hpx/chrono.hpp #pragma once @@ -18,7 +20,6 @@ #include namespace hpx::chrono { - /// \brief Class \c hpx::chrono::high_resolution_clock represents the clock /// with the smallest tick period provided by the implementation. It /// may be an alias of \c std::chrono::system_clock or diff --git a/libs/core/timing/include/hpx/timing/high_resolution_timer.hpp b/libs/core/timing/include/hpx/timing/high_resolution_timer.hpp index 03cc0b99110d..75e7bdbdf22c 100644 --- a/libs/core/timing/include/hpx/timing/high_resolution_timer.hpp +++ b/libs/core/timing/include/hpx/timing/high_resolution_timer.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file high_resolution_timer.hpp +/// \page hpx::chrono::high_resolution_timer +/// \headerfile hpx/chrono.hpp #pragma once diff --git a/libs/full/collectives/include/hpx/collectives/barrier.hpp b/libs/full/collectives/include/hpx/collectives/barrier.hpp index e846f61a7651..6c16c3c09fdf 100644 --- a/libs/full/collectives/include/hpx/collectives/barrier.hpp +++ b/libs/full/collectives/include/hpx/collectives/barrier.hpp @@ -5,6 +5,8 @@ // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) /// \file hpx/collectives/barrier.hpp +/// \page hpx::distributed::barrier +/// \headerfile hpx/barrier.hpp #pragma once