Skip to content

Commit

Permalink
Fix minor doxygen issues
Browse files Browse the repository at this point in the history
  • Loading branch information
tpadioleau committed Dec 28, 2024
1 parent 0080156 commit fada862
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions include/ddc/detail/type_seq.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ struct TypeSeqElement<I, TypeSeq<Tags...>>

/// R contains all elements in A that are not in B.
/// Remark 1: This operation preserves the order from A.
/// Remark 2: It is similar to the set difference in the set theory (R = A\B).
/// Remark 2: It is similar to the set difference in the set theory (R = A\\B).
/// Example: A = [a, b, c], B = [z, c, y], R = [a, b]
template <class TagSeqA, class TagSeqB, class TagSeqR>
struct TypeSeqRemove;
Expand Down Expand Up @@ -164,7 +164,7 @@ struct ToTypeSeq;
template <class TypeSeq>
constexpr std::size_t type_seq_size_v = std::numeric_limits<std::size_t>::max();

/// Returns the number of types in a @ref TypeSeq.
/// Returns the number of types in a @ref detail::TypeSeq.
template <class... Tags>
constexpr std::size_t type_seq_size_v<detail::TypeSeq<Tags...>> = sizeof...(Tags);

Expand Down
2 changes: 1 addition & 1 deletion include/ddc/kernels/splines/splines_linear_problem.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ class SplinesLinearProblem
/**
* @brief Solve the multiple right-hand sides linear problem Ax=b or its transposed version A^tx=b inplace.
*
* @param[in, out] multi_rhs A 2D Kokkos::View storing the multiple right-hand sides of the problem and receiving the corresponding solution.
* @param[in, out] b A 2D Kokkos::View storing the multiple right-hand sides of the problem and receiving the corresponding solution.
* @param transpose Choose between the direct or transposed version of the linear problem.
*/
virtual void solve(MultiRHS b, bool transpose) const = 0;
Expand Down
4 changes: 2 additions & 2 deletions include/ddc/kernels/splines/splines_linear_problem_sparse.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ namespace ddc::detail {
/**
* @brief Convert KokkosView to Ginkgo Dense matrix.
*
* @param gko_exec[in] A Ginkgo executor that has access to the Kokkos::View memory space
* @param view[in] A 2-D Kokkos::View with unit stride in the second dimension
* @param[in] gko_exec A Ginkgo executor that has access to the Kokkos::View memory space
* @param[in] view A 2-D Kokkos::View with unit stride in the second dimension
* @return A Ginkgo Dense matrix view over the Kokkos::View data
*/
template <class KokkosViewType>
Expand Down

0 comments on commit fada862

Please sign in to comment.