Skip to content

Commit

Permalink
Cherry-pick docs fixes into 6.2 rel (#392)
Browse files Browse the repository at this point in the history
* remove include file paths (#387)

* Docs - doxygen fix for docs not showing arithmetic, logical, audio groups (#386)

---------

Co-authored-by: randyh62 <42045079+randyh62@users.noreply.github.com>
Co-authored-by: Abishek <52214183+r-abishek@users.noreply.github.com>
  • Loading branch information
3 people authored Jun 28, 2024
1 parent 0abeeee commit 3b3427d
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 18 deletions.
6 changes: 4 additions & 2 deletions docs/doxygen/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,8 @@ FULL_PATH_NAMES = YES
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.

STRIP_FROM_PATH =
#STRIP_FROM_PATH =
STRIP_FROM_PATH = /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rpp/checkouts/latest/

# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
Expand All @@ -193,7 +194,8 @@ STRIP_FROM_PATH =
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.

STRIP_FROM_INC_PATH =
STRIP_FROM_INC_PATH =


# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
Expand Down
10 changes: 1 addition & 9 deletions include/rppt_tensor_arithmetic_operations.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,6 @@ SOFTWARE.
#ifndef RPPT_TENSOR_ARITHMETIC_OPERATIONS_H
#define RPPT_TENSOR_ARITHMETIC_OPERATIONS_H

/*!
* \file
* \brief RPPT Tensor Arithmetic operation Functions.
*
* \defgroup group_tensor_arithmetic Operations: AMD RPP Tensor Arithmetic Operations
* \brief Tensor Arithmetic Operations.
*/

#include "rpp.h"
#include "rppdefs.h"
#ifdef __cplusplus
Expand All @@ -42,7 +34,7 @@ extern "C" {
/*!
* \file
* \brief RPPT Tensor Operations - Arithmetic Operations.
* \defgroup group_tensor_arithmetic_operations RPPT Tensor Operations - Arithmetic Operations.
* \defgroup group_rppt_tensor_arithmetic_operations RPPT Tensor Operations - Arithmetic Operations.
* \brief RPPT Tensor Operations - Arithmetic Operations.
*/

Expand Down
15 changes: 9 additions & 6 deletions include/rppt_tensor_audio_augmentations.h
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ SOFTWARE.
#ifndef RPPT_TENSOR_AUDIO_AUGMENTATIONS_H
#define RPPT_TENSOR_AUDIO_AUGMENTATIONS_H

#include "rpp.h"
#include "rppdefs.h"
#ifdef __cplusplus
extern "C" {
#endif

/*!
* \file
* \brief RPPT Tensor Operations - Audio Augmentations.
Expand All @@ -36,12 +42,6 @@ SOFTWARE.
* @{
*/

#include "rpp.h"
#include "rppdefs.h"
#ifdef __cplusplus
extern "C" {
#endif

/*! \brief Non Silent Region Detection augmentation on HOST backend
* \details Non Silent Region Detection augmentation for 1D audio buffer
\n Finds the starting index and length of non silent region in the audio buffer by comparing the
Expand Down Expand Up @@ -168,6 +168,9 @@ RppStatus rppt_mel_filter_bank_host(RppPtr_t srcPtr, RpptDescPtr srcDescPtr, Rpp
*/
RppStatus rppt_resample_host(RppPtr_t srcPtr, RpptDescPtr srcDescPtr, RppPtr_t dstPtr, RpptDescPtr dstDescPtr, Rpp32f *inRateTensor, Rpp32f *outRateTensor, Rpp32s *srcDimsTensor, RpptResamplingWindow &window, rppHandle_t rppHandle);

/*! @}
*/

#ifdef __cplusplus
}
#endif
Expand Down
2 changes: 1 addition & 1 deletion include/rppt_tensor_logical_operations.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ extern "C" {
/*!
* \file
* \brief RPPT Tensor Operations - Logical Operations.
* \defgroup group_tensor_logical_operations RPPT Tensor Operations - Logical Operations.
* \defgroup group_rppt_tensor_logical_operations RPPT Tensor Operations - Logical Operations.
* \brief RPPT Tensor Operations - Logical Operations.
*/

Expand Down

0 comments on commit 3b3427d

Please sign in to comment.