Doxyfile update - Add arithmetic and audio rppt groups (#404)

* Update Doxyfile to add arithmetic and audio rppt groups * Update .Doxyfile * Update Doxyfile * Update .Doxyfile to alphabetical order inputs * Update docs/doxygen/Doxyfile to alphabetical order inputs * Update arguments addressing doxygen warnings * Update rppt_tensor_color_augmentations.h to address doxygen warnings * Update rppt_tensor_effects_augmentations.h to address doxygen warnings * Update rppt_tensor_filter_augmentations.h to address doxygen warnings * Update rppt_tensor_geometric_augmentations.h to address doxygen warnings * Update rppt_tensor_logical_operations.h to address doxygen warnings * Update rppt_tensor_morphological_operations.h to address doxygen warnings * Update rppt_tensor_statistical_operations.h --------- Co-authored-by: Kiriti Gowda <kiritigowda@gmail.com>
ROCm · Jul 24, 2024 · 6e30d48 · 6e30d48
1 parent 2a13f48
commit 6e30d48
Show file tree

Hide file tree

Showing 10 changed files with 105 additions and 103 deletions.
diff --git a/.Doxyfile b/.Doxyfile
@@ -960,16 +960,16 @@ INPUT                  = README.md \
                         include/rppi_logical_operations.h \
                         include/rppi_morphological_transforms.h \
                         include/rppi_statistical_operations.h \
+                        include/rppt_tensor_arithmetic_operations.h \
+                        include/rppt_tensor_audio_augmentations.h \
                         include/rppt_tensor_color_augmentations.h \
                         include/rppt_tensor_data_exchange_operations.h \
                         include/rppt_tensor_effects_augmentations.h \
                         include/rppt_tensor_filter_augmentations.h \
                         include/rppt_tensor_geometric_augmentations.h \
+                        include/rppt_tensor_logical_operations.h \
                         include/rppt_tensor_morphological_operations.h \
-                        include/rppt_tensor_statistical_operations.h \
-                        include/rppt_tensor_arithmetic_operations.h \
-                        include/rppt_tensor_audio_augmentations.h \
-                        include/rppt_tensor_logical_operations.h
+                        include/rppt_tensor_statistical_operations.h
 
 
 # This tag can be used to specify the character encoding of the source files
@@ -2381,7 +2381,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = GPU_SUPPORT RPP_BACKEND_HIP HIP_COMPILE
+PREDEFINED             = GPU_SUPPORT RPP_BACKEND_HIP HIP_COMPILE AUDIO_SUPPORT
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile
@@ -962,14 +962,16 @@ INPUT                  = ../../README.md \
                         ../../include/rppi_logical_operations.h \
                         ../../include/rppi_morphological_transforms.h \
                         ../../include/rppi_statistical_operations.h \
+                        ../../include/rppt_tensor_arithmetic_operations.h \
+                        ../../include/rppt_tensor_audio_augmentations.h \
                         ../../include/rppt_tensor_color_augmentations.h \
                         ../../include/rppt_tensor_data_exchange_operations.h \
                         ../../include/rppt_tensor_effects_augmentations.h \
                         ../../include/rppt_tensor_filter_augmentations.h \
                         ../../include/rppt_tensor_geometric_augmentations.h \
+                        ../../include/rppt_tensor_logical_operations.h \
                         ../../include/rppt_tensor_morphological_operations.h \
-                        ../../include/rppt_tensor_statistical_operations.h \
-                        ../../include/rppt_tensor_logical_operations.h
+                        ../../include/rppt_tensor_statistical_operations.h
 
 
 # This tag can be used to specify the character encoding of the source files
@@ -2381,7 +2383,7 @@ INCLUDE_FILE_PATTERNS  =
 # recursively expanded use the := operator instead of the = operator.
 # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
 
-PREDEFINED             = GPU_SUPPORT RPP_BACKEND_HIP HIP_COMPILE
+PREDEFINED             = GPU_SUPPORT RPP_BACKEND_HIP HIP_COMPILE AUDIO_SUPPORT
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

diff --git a/include/rppt_tensor_arithmetic_operations.h b/include/rppt_tensor_arithmetic_operations.h
@@ -190,7 +190,7 @@ RppStatus rppt_subtract_scalar_gpu(RppPtr_t srcPtr, RpptGenericDescPtr srcGeneri
  * \retval RPP_SUCCESS Successful completion.
  * \retval RPP_ERROR* Unsuccessful completion.
  */
-RppStatus rppt_multiply_scalar_host(RppPtr_t srcPtr, RpptGenericDescPtr srcGenericDescPtr, RppPtr_t dstPtr, RpptGenericDescPtr dstGenericDescPtr, Rpp32f *subtractTensor, RpptROI3DPtr roiGenericPtrSrc, RpptRoi3DType roiType, rppHandle_t rppHandle);
+RppStatus rppt_multiply_scalar_host(RppPtr_t srcPtr, RpptGenericDescPtr srcGenericDescPtr, RppPtr_t dstPtr, RpptGenericDescPtr dstGenericDescPtr, Rpp32f *mulTensor, RpptROI3DPtr roiGenericPtrSrc, RpptRoi3DType roiType, rppHandle_t rppHandle);
 
 #ifdef GPU_SUPPORT
 /*! \brief Multiply scalar augmentation on HIP backend
@@ -226,7 +226,7 @@ RppStatus rppt_multiply_scalar_gpu(RppPtr_t srcPtr, RpptGenericDescPtr srcGeneri
  * \param [in] srcDescPtr source tensor descriptor (Restrictions - numDims = 4, offsetInBytes >= 0, dataType = U8/F16/F32/I8, layout = NCHW/NHWC, c = 1/3)
  * \param [out] dstPtr destination tensor in HOST memory
  * \param [in] dstDescPtr destination tensor descriptor (Restrictions - numDims = 4, offsetInBytes >= 0, dataType = U8/F16/F32/I8, layout = NCHW/NHWC, c = same as that of srcDescPtr)
- * \param [in] roiTensorSrc ROI data in HOST memory, for each image in source tensor (2D tensor of size batchSize * 4, in either format - XYWH(xy.x, xy.y, roiWidth, roiHeight) or LTRB(lt.x, lt.y, rb.x, rb.y))
+ * \param [in] roiTensorPtrSrc ROI data in HOST memory, for each image in source tensor (2D tensor of size batchSize * 4, in either format - XYWH(xy.x, xy.y, roiWidth, roiHeight) or LTRB(lt.x, lt.y, rb.x, rb.y))
  * \param [in] roiType ROI type used (RpptRoiType::XYWH or RpptRoiType::LTRB)
  * \param [in] rppHandle RPP HOST handle created with <tt>\ref rppCreateWithBatchSize()</tt>
  * \return A <tt> \ref RppStatus</tt> enumeration.
@@ -248,7 +248,7 @@ RppStatus rppt_magnitude_host(RppPtr_t srcPtr1, RppPtr_t srcPtr2, RpptDescPtr sr
  * \param [in] srcDescPtr source tensor descriptor (Restrictions - numDims = 4, offsetInBytes >= 0, dataType = U8/F16/F32/I8, layout = NCHW/NHWC, c = 1/3)
  * \param [out] dstPtr destination tensor in HIP memory
  * \param [in] dstDescPtr destination tensor descriptor (Restrictions - numDims = 4, offsetInBytes >= 0, dataType = U8/F16/F32/I8, layout = NCHW/NHWC, c = same as that of srcDescPtr)
- * \param [in] roiTensorSrc ROI data in HIP memory, for each image in source tensor (2D tensor of size batchSize * 4, in either format - XYWH(xy.x, xy.y, roiWidth, roiHeight) or LTRB(lt.x, lt.y, rb.x, rb.y))
+ * \param [in] roiTensorPtrSrc ROI data in HIP memory, for each image in source tensor (2D tensor of size batchSize * 4, in either format - XYWH(xy.x, xy.y, roiWidth, roiHeight) or LTRB(lt.x, lt.y, rb.x, rb.y))
  * \param [in] roiType ROI type used (RpptRoiType::XYWH or RpptRoiType::LTRB)
  * \param [in] rppHandle RPP HIP handle created with <tt>\ref rppCreateWithStreamAndBatchSize()</tt>
  * \return A <tt> \ref RppStatus</tt> enumeration.