Merge branch 'fix-doxygen-warnings' into 'develop_stream_2023_10_18'

Resolve doxygen warnings for upstream PR

See merge request amd/libraries/rocPRIM!561

docs/device_ops/sort.rst

@@ -7,7 +7,7 @@ Configuring the kernel
 merge_sort
 ..........
 
-.. doxygentypedef:: rocprim::merge_sort_config
+.. doxygenstruct:: rocprim::merge_sort_config
 
 radix_sort
 ..........

docs/device_ops/transform.rst

@@ -4,7 +4,7 @@ Transform
 Configuring the kernel
 ~~~~~~~~~~~~~~~~~~~~~~
 
-.. doxygentypedef:: rocprim::transform_config
+.. doxygenstruct:: rocprim::transform_config
 
 transform
 ~~~~~~~~~

docs/intrinsics.rst

@@ -12,8 +12,8 @@ Warp size
 ---------
 
 .. doxygenfunction:: rocprim::warp_size()
-.. doxygenfunction:: rocprim::host_warp_size(const int device_id)
-.. doxygenfunction:: rocprim::host_warp_size(const hipStream_t stream)
+.. doxygenfunction:: rocprim::host_warp_size(const int device_id, unsigned int& warp_size)
+.. doxygenfunction:: rocprim::host_warp_size(const hipStream_t stream, unsigned int& warp_size)
 .. doxygenfunction:: rocprim::device_warp_size()
 
 Lane and Warp ID

rocprim/include/rocprim/block/block_radix_sort.hpp

@@ -884,6 +884,7 @@ class block_radix_sort
     }
 };
 
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
 template<class Key,
          unsigned int BlockSizeX,
          unsigned int ItemsPerThread,
@@ -893,6 +894,7 @@ template<class Key,
 constexpr unsigned int
     block_radix_sort<Key, BlockSizeX, ItemsPerThread, Value, BlockSizeY, BlockSizeZ>::
         radix_bits_per_pass;
+#endif
 
 END_ROCPRIM_NAMESPACE
 

rocprim/include/rocprim/block/block_run_length_decode.hpp

@@ -167,6 +167,14 @@ class block_run_length_decode
     uint32_t linear_tid;
 
 public:
+    /// \brief Struct used to allocate a temporary memory that is required for thread
+    /// communication during operations provided by related parallel primitive.
+    ///
+    /// Depending on the implemention the operations exposed by parallel primitive may
+    /// require a temporary storage for thread communication. The storage should be allocated
+    /// using keywords <tt>__shared__</tt>. It can be aliased to
+    /// an externally allocated memory, or be a part of a union type with other storage types
+    /// to increase shared memory reusability.
     using storage_type = detail::raw_storage<storage_type_>;
 
     /**
@@ -290,7 +298,6 @@ class block_run_length_decode
      * \p item_offsets can be used to retrieve each run-length decoded item's relative index within its run. E.g., the
      * run-length encoded array of `3, 1, 4` with the respective run lengths of `2, 1, 3` would yield the run-length
      * decoded array of `3, 3, 1, 4, 4, 4` with the relative offsets of `0, 1, 0, 0, 1, 2`.
-     * \smemreuse
      *
      * \param[out] decoded_items The run-length decoded items to be returned in a blocked arrangement
      * \param[out] item_offsets The run-length decoded items' relative offset within the run they belong to

rocprim/include/rocprim/device/detail/device_config_helper.hpp

@@ -242,6 +242,7 @@ template<unsigned int                      BlockSize      = 256,
          unsigned int SizeLimit = ROCPRIM_GRID_SIZE_LIMIT>
 struct reduce_config : rocprim::detail::reduce_config_params
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::reduce_config_tag;
     constexpr reduce_config()
         : rocprim::detail::reduce_config_params{
@@ -299,6 +300,7 @@ template<unsigned int                    BlockSize,
          unsigned int                    SizeLimit = ROCPRIM_GRID_SIZE_LIMIT>
 struct scan_config : ::rocprim::detail::scan_config_params
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::scan_config_tag;
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
     // Requirement dictated by init_lookback_scan_state_kernel.
@@ -379,6 +381,7 @@ template<unsigned int                    BlockSize,
          unsigned int                    SizeLimit = ROCPRIM_GRID_SIZE_LIMIT>
 struct scan_by_key_config : ::rocprim::detail::scan_by_key_config_params
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::scan_by_key_config_tag;
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
     // Requirement dictated by init_lookback_scan_state_kernel.
@@ -448,6 +451,7 @@ template<unsigned int BlockSize,
          unsigned int SizeLimit = ROCPRIM_GRID_SIZE_LIMIT>
 struct transform_config : public detail::transform_config_params
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::transform_config_tag;
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
 
@@ -502,6 +506,7 @@ template<unsigned int BlockSize,
          unsigned int SizeLimit = ROCPRIM_GRID_SIZE_LIMIT>
 struct binary_search_config : transform_config<BlockSize, ItemsPerThread, SizeLimit>
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::binary_search_config_tag;
 };
 
@@ -514,6 +519,7 @@ template<unsigned int BlockSize,
          unsigned int SizeLimit = ROCPRIM_GRID_SIZE_LIMIT>
 struct upper_bound_config : transform_config<BlockSize, ItemsPerThread, SizeLimit>
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::upper_bound_config_tag;
 };
 
@@ -526,6 +532,7 @@ template<unsigned int BlockSize,
          unsigned int SizeLimit = ROCPRIM_GRID_SIZE_LIMIT>
 struct lower_bound_config : transform_config<BlockSize, ItemsPerThread, SizeLimit>
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::lower_bound_config_tag;
 };
 
@@ -571,6 +578,7 @@ template<class HistogramConfig,
          unsigned int SharedImplHistograms = 3>
 struct histogram_config : detail::histogram_config_params
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::histogram_config_tag;
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
     using histogram = HistogramConfig;
@@ -628,6 +636,7 @@ template<unsigned int       BlockSize,
          unsigned int       SizeLimit        = ROCPRIM_GRID_SIZE_LIMIT>
 struct adjacent_difference_config : public detail::adjacent_difference_config_params
 {
+    /// \brief Identifies the algorithm associated to the config.
     using tag = detail::adjacent_difference_config_tag;
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
     static constexpr ::rocprim::block_load_method  block_load_method  = BlockLoadMethod;