diff options
| author | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-05-12 08:27:15 +0100 |
|---|---|---|
| committer | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-05-18 09:48:12 +0100 |
| commit | 56ee6207c1524ddc4c444c6e48e05eb34105985a (patch) | |
| tree | d4fc7823961034e95364f44b34fb098b34b99d0d /source/use_case/ad/src/UseCaseHandler.cc | |
| parent | f4e2c4736f19d2e06fede715bb49c475f93d79a9 (diff) | |
| download | ml-embedded-evaluation-kit-56ee6207c1524ddc4c444c6e48e05eb34105985a.tar.gz | |
MLECO-1858: Documentation update
* Removing `_` in front of private functions and member
Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
Change-Id: I5a5d652f9647ebb16d2d2bd16ab980e73f7be3cf
Diffstat (limited to 'source/use_case/ad/src/UseCaseHandler.cc')
| -rw-r--r-- | source/use_case/ad/src/UseCaseHandler.cc | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/source/use_case/ad/src/UseCaseHandler.cc b/source/use_case/ad/src/UseCaseHandler.cc index 233b0f4..ec35156 100644 --- a/source/use_case/ad/src/UseCaseHandler.cc +++ b/source/use_case/ad/src/UseCaseHandler.cc @@ -30,13 +30,13 @@ namespace app { /** * @brief Helper function to increment current audio clip index - * @param[in/out] ctx pointer to the application context object + * @param[in,out] ctx pointer to the application context object **/ static void IncrementAppCtxClipIdx(ApplicationContext& ctx); /** * @brief Helper function to set the audio clip index - * @param[in/out] ctx pointer to the application context object + * @param[in,out] ctx pointer to the application context object * @param[in] idx value to be set * @return true if index is set, false otherwise **/ @@ -47,7 +47,7 @@ namespace app { * object. * @param[in] platform reference to the hal platform object * @param[in] result average sum of classification results - * @param[in] threhsold if larger than this value we have an anomaly + * @param[in] threshold if larger than this value we have an anomaly * @return true if successful, false otherwise **/ static bool PresentInferenceResult(hal_platform& platform, float result, float threshold); @@ -61,9 +61,10 @@ namespace app { * * Warning: mfcc calculator provided as input must have the same life scope as returned function. * - * @param[in] mfcc MFCC feature calculator. - * @param[in/out] inputTensor Input tensor pointer to store calculated features. - * @param[i] cacheSize Size of the feture vectors cache (number of feature vectors). + * @param[in] melSpec MFCC feature calculator. + * @param[in,out] inputTensor Input tensor pointer to store calculated features. + * @param[in] cacheSize Size of the feture vectors cache (number of feature vectors). + * @param[in] trainingMean Training mean. * @return function function to be called providing audio sample and sliding window index. */ static std::function<void (std::vector<int16_t>&, int, bool, size_t, size_t)> |