From dff93a19b892b2f9bcc708541b09f0395f87648d Mon Sep 17 00:00:00 2001 From: Carl Pearson Date: Mon, 10 Apr 2023 14:34:29 -0600 Subject: [PATCH] Blas: Don't document return values of functions that don't return --- blas/src/KokkosBlas1_mult.hpp | 2 -- blas/src/KokkosBlas1_swap.hpp | 9 +++------ 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/blas/src/KokkosBlas1_mult.hpp b/blas/src/KokkosBlas1_mult.hpp index 47fa1f536f..f390b3556a 100644 --- a/blas/src/KokkosBlas1_mult.hpp +++ b/blas/src/KokkosBlas1_mult.hpp @@ -40,8 +40,6 @@ namespace KokkosBlas { /// \param alpha [in] The scalar to apply to A. /// \param A [in] The vector to apply to X. /// \param X [in] The X vector. -/// -/// \return Y = gamma * Y + alpha * A * X. template void mult(const execution_space& space, typename YMV::const_value_type& gamma, const YMV& Y, typename AV::const_value_type& alpha, const AV& A, diff --git a/blas/src/KokkosBlas1_swap.hpp b/blas/src/KokkosBlas1_swap.hpp index f91d090cd5..26c529f3b7 100644 --- a/blas/src/KokkosBlas1_swap.hpp +++ b/blas/src/KokkosBlas1_swap.hpp @@ -33,10 +33,9 @@ namespace KokkosBlas { /// \param x [in/out] 1-D View. /// \param y [in/out] 1-D View. /// -/// \return x and y with swapped values, note that this is akin to -/// performing a deep_copy, swapping pointers inside view -/// can only be performed if no aliasing, subviews, etc... -/// exist, which cannot be asserted by this function. +/// Swaps x and y. Note that this is akin to performing a deep_copy, swapping +/// pointers inside view can only be performed if no aliasing, subviews, etc... +/// exist, which cannot be asserted by this function. /// /// This function is non-blocking unless the underlying TPL requested /// at compile time is itself blocking @@ -107,8 +106,6 @@ void swap(execution_space const& space, XVector const& x, YVector const& y) { /// \param x [in/out] 1-D View. /// \param y [in/out] 1-D View. /// -/// \return x and y with swapped values. -/// /// This function is non-blocking unless the underlying TPL requested /// at compile time is itself blocking. Note that the kernel will be /// executed on the default stream of the execution_space associted with x.