From 11f999ed654f183f799469eab81b3d5731bc42d2 Mon Sep 17 00:00:00 2001 From: david-cortes-intel Date: Wed, 11 Dec 2024 14:03:08 +0100 Subject: [PATCH] DOC: Clear warnings from roxygen build (#3004) * clear warnings from doc CI job * another attempt * attempt at clearing obsolence warning * add tag for mathjax * Update cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp Co-authored-by: Victoriya Fedotova * Update cpp/oneapi/dal/graph/service_functions.hpp Co-authored-by: Victoriya Fedotova --------- Co-authored-by: Victoriya Fedotova --- cpp/oneapi/dal/algo/jaccard/common.hpp | 1 - .../algo/jaccard/vertex_similarity_types.hpp | 4 ++-- cpp/oneapi/dal/graph/service_functions.hpp | 2 +- cpp/oneapi/dal/spmd/communicator.hpp | 22 ++++++++++++------- cpp/oneapi/dal/test/engine/linalg/random.hpp | 2 +- docs/doxygen/oneapi/Doxyfile | 7 ------ 6 files changed, 18 insertions(+), 20 deletions(-) diff --git a/cpp/oneapi/dal/algo/jaccard/common.hpp b/cpp/oneapi/dal/algo/jaccard/common.hpp index 85dd55ebffb..3ec52aa3b2d 100644 --- a/cpp/oneapi/dal/algo/jaccard/common.hpp +++ b/cpp/oneapi/dal/algo/jaccard/common.hpp @@ -148,7 +148,6 @@ struct ONEDAL_EXPORT caching_builder { /// Returns the pointer to the allocated memory of size block_max_size. /// /// @param [in] block_max_size The required size of memory - /// @param [in/out] builder The caching builder void* operator()(std::int64_t block_max_size); std::shared_ptr result_ptr; diff --git a/cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp b/cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp index 95374517228..b34b0a97620 100644 --- a/cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp +++ b/cpp/oneapi/dal/algo/jaccard/vertex_similarity_types.hpp @@ -39,8 +39,8 @@ class vertex_similarity_input : public base { "Only undirected_adjacency_vector_graph is supported."); /// Constructs the algorithm input initialized with the graph and the caching builder. /// - /// @param [in] graph The input graph - /// @param [in/out] builder The caching builder + /// @param [in] g The input graph + /// @param [in, out] builder The caching builder vertex_similarity_input(const Graph& g, caching_builder& builder); /// Returns the constant reference to the input graph diff --git a/cpp/oneapi/dal/graph/service_functions.hpp b/cpp/oneapi/dal/graph/service_functions.hpp index 608be94dadf..078abddc111 100644 --- a/cpp/oneapi/dal/graph/service_functions.hpp +++ b/cpp/oneapi/dal/graph/service_functions.hpp @@ -90,7 +90,7 @@ constexpr auto get_vertex_outward_neighbors(const Graph &g, vertex_type u /// Returns the value of an edge (u, v) /// /// @tparam Graph Type of the graph -/// @param [in] graph Input graph object +/// @param [in] g Input graph object /// @param [in] u Source vertex index /// @param [in] v Destination vertex index /// diff --git a/cpp/oneapi/dal/spmd/communicator.hpp b/cpp/oneapi/dal/spmd/communicator.hpp index b5eebf27ef7..cc5dc6e4028 100644 --- a/cpp/oneapi/dal/spmd/communicator.hpp +++ b/cpp/oneapi/dal/spmd/communicator.hpp @@ -251,18 +251,24 @@ class communicator : public base { } template request bcast(const array& ary, std::int64_t root = -1) const; + /// Gathers data from all ranks and distributes the results back to all ranks /// - /// @param send_buf The send buffer - /// @param send_count The number of elements of `dtype` in `send_buf` - /// @param recv_buf The receiving buffer - /// @param recv_count The number of elements of `dtype` in `recv_buf` - /// @param dtype The type of elements in the passed buffers + /// @param send The send buffer + /// @param recv The receiving buffer + /// @tparam D The type of elements in the passed buffers /// /// @return The object to track the progress of the operation template request allgather(const array& send, const array& recv) const; + /// Gathers data from all ranks and distributes the results back to all ranks + /// + /// @param scalar The send element + /// @param recv The receiving buffer + /// @tparam D The type of elements in send / recv + /// + /// @return The object to track the progress of the operation template request allgather(const D& scalar, const array& recv) const; /// Collects data from all the ranks within a communicator into a single buffer @@ -274,9 +280,9 @@ class communicator : public base { /// @param recv_buf The receiveing buffer, must contain at least /// `rank_count * recv_count` elements, /// significant only at `root` - /// @param recv_count The number of elements of `dtype` received from - /// each rank, must contain at least `rank_count` elements, - /// significant only at `root` + /// @param recv_counts The number of elements of `dtype` received from + /// each rank, must contain at least `rank_count` elements, + /// significant only at `root` /// @param displs Entry $i$ specifies the displacement relative to /// `recv_buf` at which to place the incoming data /// from process $i$, must contain at least `rank_count` diff --git a/cpp/oneapi/dal/test/engine/linalg/random.hpp b/cpp/oneapi/dal/test/engine/linalg/random.hpp index 2a33c12978f..199d904d57b 100644 --- a/cpp/oneapi/dal/test/engine/linalg/random.hpp +++ b/cpp/oneapi/dal/test/engine/linalg/random.hpp @@ -35,7 +35,7 @@ inline matrix generate_uniform_matrix(const shape& s, T a, T b, int seed) { } /// Generates symmetric positive-definite matrix with diagonal dominance. -/// $\frac{1}{2}(A + A^T) + nE$, where $A$ is uniformly distributed matrix, $dim(A) = n$. +/// \f$\frac{1}{2}(A + A^T) + nE\f$, where $A$ is uniformly distributed matrix, \f$dim(A) = n\f$. template inline matrix generate_symmetric_positive_matrix(std::int64_t dim, Float a, diff --git a/docs/doxygen/oneapi/Doxyfile b/docs/doxygen/oneapi/Doxyfile index 93dd88f6320..58cd89baf3e 100644 --- a/docs/doxygen/oneapi/Doxyfile +++ b/docs/doxygen/oneapi/Doxyfile @@ -1128,13 +1128,6 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored