Add docs

NVIDIA · Oct 30, 2024 · 0d45a26 · 0d45a26
1 parent 19ee552
commit 0d45a26
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/include/cuco/extent.cuh b/include/cuco/extent.cuh
@@ -117,6 +117,13 @@ template <int32_t CGSize, int32_t BucketSize, typename SizeType, std::size_t N>
  *
  * @deprecated Use the equivalent `make_bucket_extent` instead.
  *
+ * @tparam CGSize Number of elements handled per CG
+ * @tparam BucketSize Number of elements handled per Bucket
+ * @tparam SizeType Size type
+ * @tparam N Extent
+ *
+ * @param ext The input extent
+ *
  * @throw If the input extent is invalid
  *
  * @return Resulting valid extent
@@ -151,6 +158,12 @@ template <int32_t CGSize, int32_t BucketSize, typename SizeType>
  *
  * @deprecated Use the equivalent `make_bucket_extent` instead.
  *
+ * @tparam CGSize Number of elements handled per CG
+ * @tparam BucketSize Number of elements handled per Bucket
+ * @tparam SizeType Size type
+ *
+ * @param size The input size
+ *
  * @throw If the input size is invalid
  *
  * @return Resulting valid extent
@@ -191,6 +204,12 @@ template <typename Container, typename SizeType, std::size_t N>
  *
  * @deprecated Use the equivalent `make_bucket_extent` instead.
  *
+ * @tparam Container Container type to compute the extent for
+ * @tparam SizeType Size type
+ * @tparam N Extent
+ *
+ * @param ext The input extent
+ *
  * @throw If the input extent is invalid
  *
  * @return Resulting valid `bucket extent`
@@ -224,6 +243,11 @@ template <typename Container, typename SizeType>
  *
  * @deprecated Use the equivalent `make_bucket_extent` instead.
  *
+ * @tparam Container Container type to compute the extent for
+ * @tparam SizeType Size type
+ *
+ * @param size The input size
+ *
  * @throw If the input size is invalid
  *
  * @return Resulting valid extent