From b7f336e2435694884f2e442fb44935e7c94f36cb Mon Sep 17 00:00:00 2001 From: Paul Fd Date: Wed, 8 Apr 2020 14:00:40 +0200 Subject: [PATCH] Correct documentation --- src/sfizz.h | 24 ++++++++++-------------- src/sfizz.hpp | 4 ++-- 2 files changed, 12 insertions(+), 16 deletions(-) diff --git a/src/sfizz.h b/src/sfizz.h index 63482393..ab55f5d2 100644 --- a/src/sfizz.h +++ b/src/sfizz.h @@ -398,50 +398,46 @@ SFIZZ_EXPORTED_API void sfizz_clear_external_definitions(sfizz_synth_t* synth); /** * @brief Get the number of note labels registered in the current sfz file - * @version 0.4.0-dev + * @since 0.4.0-dev */ SFIZZ_EXPORTED_API unsigned int sfizz_get_num_note_labels(sfizz_synth_t* synth); /** * @brief Get the note number for the label registered at index label_index. - * @version 0.4.0-dev + * @since 0.4.0-dev * - * @returns SFIZZ_OUT_OF_BOUNDS_LABEL_INDEX if the index is out of bounds. - * @returns the number + * @returns the number or SFIZZ_OUT_OF_BOUNDS_LABEL_INDEX if the index is out of bounds. */ SFIZZ_EXPORTED_API int sfizz_get_note_label_number(sfizz_synth_t* synth, int label_index); /** * @brief Get the note text for the label registered at index label_index. - * @version 0.4.0-dev + * @since 0.4.0-dev * - * @returns NULL if the index is out of bounds. - * @returns the label + * @returns the label or NULL if the index is out of bounds. */ SFIZZ_EXPORTED_API const char * sfizz_get_note_label_text(sfizz_synth_t* synth, int label_index); /** * @brief Get the number of note labels registered in the current sfz file - * @version 0.4.0-dev + * @since 0.4.0-dev * */ SFIZZ_EXPORTED_API unsigned int sfizz_get_num_cc_labels(sfizz_synth_t* synth); /** * @brief Get the CC number for the label registered at index label_index. - * @version 0.4.0-dev + * @since 0.4.0-dev * - * @returns SFIZZ_OUT_OF_BOUNDS_LABEL_INDEX if the index is out of bounds. - * @returns the number + * @returns the number or SFIZZ_OUT_OF_BOUNDS_LABEL_INDEX if the index is out of bounds. */ SFIZZ_EXPORTED_API int sfizz_get_cc_label_number(sfizz_synth_t* synth, int label_index); /** * @brief Get the CC text for the label registered at index label_index. - * @version 0.4.0-dev + * @since 0.4.0-dev * - * @returns NULL if the index is out of bounds. - * @returns the label + * @returns the label or NULL if the index is out of bounds. */ SFIZZ_EXPORTED_API const char * sfizz_get_cc_label_text(sfizz_synth_t* synth, int label_index); diff --git a/src/sfizz.hpp b/src/sfizz.hpp index d726d6c5..f8885259 100644 --- a/src/sfizz.hpp +++ b/src/sfizz.hpp @@ -316,13 +316,13 @@ public: /** * @brief Get the note labels, if any - * @version 0.4.0-dev + * @since 0.4.0-dev * */ const std::vector>& getNoteLabels() const noexcept; /** * @brief Get the CC labels, if any - * @version 0.4.0-dev + * @since 0.4.0-dev * */ const std::vector>& getCCLabels() const noexcept;