Skip to content

Commit

Permalink
Blas: Don't document return values of functions that don't return
Browse files Browse the repository at this point in the history
  • Loading branch information
cwpearson committed Jun 22, 2023
1 parent 6763ff0 commit dff93a1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 8 deletions.
2 changes: 0 additions & 2 deletions blas/src/KokkosBlas1_mult.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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 <class execution_space, class YMV, class AV, class XMV>
void mult(const execution_space& space, typename YMV::const_value_type& gamma,
const YMV& Y, typename AV::const_value_type& alpha, const AV& A,
Expand Down
9 changes: 3 additions & 6 deletions blas/src/KokkosBlas1_swap.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit dff93a1

Please sign in to comment.