Skip to content

Commit

Permalink
Missing blank line after \brief
Browse files Browse the repository at this point in the history
  • Loading branch information
karthikeyann committed Jun 1, 2022
1 parent d9ae9d4 commit 0e2801f
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
1 change: 1 addition & 0 deletions cpp/include/cudf/utilities/error.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ struct logic_error : public std::logic_error {
};
/**
* @brief Exception thrown when a CUDA error is encountered.
*
*/
struct cuda_error : public std::runtime_error {
/**
Expand Down
11 changes: 9 additions & 2 deletions cpp/include/cudf/utilities/span.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@

namespace cudf {

/// A constant of type std::size_t that is used to differentiate std::span of static and dynamic
/// extent
/// A constant used to differentiate std::span of static and dynamic extent
constexpr std::size_t dynamic_extent = std::numeric_limits<std::size_t>::max();

namespace detail {

/**
* @brief C++20 std::span with reduced feature set.
*
*/
template <typename T, std::size_t Extent, typename Derived>
class span_base {
Expand Down Expand Up @@ -78,6 +78,7 @@ class span_base {
// not noexcept due to undefined behavior when size = 0
/**
* @brief Returns a reference to the first element in the span.
*
* Calling front on an empty span results in undefined behavior.
*
* @return Reference to the first element in the span
Expand All @@ -86,6 +87,7 @@ class span_base {
// not noexcept due to undefined behavior when size = 0
/**
* @brief Returns a reference to the last element in the span.
*
* Calling last on an empty span results in undefined behavior.
*
* @return Reference to the last element in the span
Expand All @@ -94,6 +96,7 @@ class span_base {
// not noexcept due to undefined behavior when idx < 0 || idx >= size
/**
* @brief Returns a reference to the idx-th element of the sequence.
*
* The behavior is undefined if idx is out of range (i.e., if it is greater than or equal to
* size()).
*
Expand All @@ -104,13 +107,15 @@ class span_base {

/**
* @brief Returns an iterator to the first element of the span.
*
* If the span is empty, the returned iterator will be equal to end().
*
* @return An iterator to the first element of the span
*/
constexpr iterator begin() const noexcept { return _data; }
/**
* @brief Returns an iterator to the element following the last element of the span.
*
* This element acts as a placeholder; attempting to access it results in undefined behavior.
*
* @return An iterator to the element following the last element of the span
Expand Down Expand Up @@ -203,6 +208,7 @@ struct is_host_span_supported_container< //

/**
* @brief C++20 std::span with reduced feature set.
*
*/
template <typename T, std::size_t Extent = cudf::dynamic_extent>
struct host_span : public cudf::detail::span_base<T, Extent, host_span<T, Extent>> {
Expand Down Expand Up @@ -273,6 +279,7 @@ struct is_device_span_supported_container< //

/**
* @brief Device version of C++20 std::span with reduced feature set.
*
*/
template <typename T, std::size_t Extent = cudf::dynamic_extent>
struct device_span : public cudf::detail::span_base<T, Extent, device_span<T, Extent>> {
Expand Down
2 changes: 2 additions & 0 deletions cpp/include/cudf/utilities/traits.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ constexpr inline bool is_relationally_comparable()
namespace detail {
/**
* @brief Helper functor to check if a specified type `T` supports relational comparisons.
*
*/
struct unary_relationally_comparable_functor {
/**
Expand Down Expand Up @@ -184,6 +185,7 @@ constexpr inline bool is_equality_comparable()
namespace detail {
/**
* @brief Helper functor to check if a specified type `T` supports equality comparisons.
*
*/
struct unary_equality_comparable_functor {
/**
Expand Down

0 comments on commit 0e2801f

Please sign in to comment.