commit 577e4d396a1ab2501b8070add91b000226787ee5
parent 788045ba80f4ea84a02e08ab28aec8233c1c4dd3
Author: Johannes Lorenz <johannes89@ist-einmalig.de>
Date: Wed, 13 Sep 2017 20:54:58 +0200
Enable Doxygen's autobrief
Diffstat:
3 files changed, 7 insertions(+), 9 deletions(-)
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
@@ -28,8 +28,8 @@ FULL_PATH_NAMES = YES
STRIP_FROM_PATH = @CMAKE_DOXYGEN_INPUT_LIST@
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
-JAVADOC_AUTOBRIEF = NO
-QT_AUTOBRIEF = NO
+JAVADOC_AUTOBRIEF = YES
+QT_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
diff --git a/src/Params/EnvelopeParams.h b/src/Params/EnvelopeParams.h
@@ -55,8 +55,8 @@ class EnvelopeParams:public Presets
static float dt(char val);
static char inv_dt(float val);
- //! @brief defines where it is used and its default settings
- //! corresponds to envelope_type_t
+ //! Defines where it is used and its default settings.
+ //! Corresponds to envelope_type_t
int envelope_type;
/* MIDI Parameters */
diff --git a/src/Params/PADnoteParameters.h b/src/Params/PADnoteParameters.h
@@ -23,7 +23,7 @@
namespace zyn {
/**
- * @brief Parameters for PAD synthesis
+ * Parameters for PAD synthesis
*
* @note unlike most other parameter objects significant portions of this
* object are `owned' by the non-realtime context. The realtime context only
@@ -151,8 +151,7 @@ class PADnoteParameters:public Presets
float getNhr(int n) const;
void applyparameters(void);
- //! @brief Compute the #sample array from the other parameters.
- //!
+ //! Compute the #sample array from the other parameters.
//! For the function's parameters, see sampleGenerator()
void applyparameters(std::function<bool()> do_abort,
unsigned max_threads = 0);
@@ -172,8 +171,7 @@ class PADnoteParameters:public Presets
typedef std::function<void(int,PADnoteParameters::Sample&)> callback;
- //! @brief PAD synth main function
- //!
+ //! PAD synth main function
//! Generate spectrum and run IFFTs on it
//! @param cb A callback that will be executed for each sample buffer
//! Note that this function can be executed by multiple