summaryrefslogtreecommitdiff
path: root/src/filter
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2015-03-17 11:21:29 +0100
committerMax Kellermann <max@duempel.org>2015-03-17 11:21:43 +0100
commitb31d171ae87dabe8026934c60b1a1195dddd32a2 (patch)
treea2ccb96a730049950f1f94df22b9147220dd16fc /src/filter
parent085f06594c38333536040d19eec21240cf98b12c (diff)
*: doxygen fixups
Diffstat (limited to 'src/filter')
-rw-r--r--src/filter/FilterConfig.hxx2
-rw-r--r--src/filter/FilterInternal.hxx8
-rw-r--r--src/filter/FilterPlugin.hxx4
-rw-r--r--src/filter/plugins/ReplayGainFilterPlugin.hxx4
4 files changed, 7 insertions, 11 deletions
diff --git a/src/filter/FilterConfig.hxx b/src/filter/FilterConfig.hxx
index 93bebfdd3..1c6f14f73 100644
--- a/src/filter/FilterConfig.hxx
+++ b/src/filter/FilterConfig.hxx
@@ -34,7 +34,7 @@ class Error;
* configured filter sections.
* @param chain the chain to append filters on
* @param spec the filter chain specification
- * @param error_r space to return an error description
+ * @param error space to return an error description
* @return true on success
*/
bool
diff --git a/src/filter/FilterInternal.hxx b/src/filter/FilterInternal.hxx
index 86a4cfd87..6969e8a18 100644
--- a/src/filter/FilterInternal.hxx
+++ b/src/filter/FilterInternal.hxx
@@ -38,12 +38,10 @@ public:
/**
* Opens the filter, preparing it for FilterPCM().
*
- * @param filter the filter object
* @param af the audio format of incoming data; the
* plugin may modify the object to enforce another input
* format
- * @param error location to store the error occurring, or nullptr
- * to ignore errors.
+ * @param error location to store the error occurring
* @return the format of outgoing data or
* AudioFormat::Undefined() on error
*/
@@ -57,10 +55,8 @@ public:
/**
* Filters a block of PCM data.
*
- * @param filter the filter object
* @param src the input buffer
- * @param error location to store the error occurring, or nullptr
- * to ignore errors.
+ * @param error location to store the error occurring
* @return the destination buffer on success (will be
* invalidated by Close() or FilterPCM()), nullptr on
* error
diff --git a/src/filter/FilterPlugin.hxx b/src/filter/FilterPlugin.hxx
index b60566c49..68ad74240 100644
--- a/src/filter/FilterPlugin.hxx
+++ b/src/filter/FilterPlugin.hxx
@@ -43,7 +43,7 @@ struct filter_plugin {
* Creates a new instance of the specified filter plugin.
*
* @param plugin the filter plugin
- * @param param optional configuration section
+ * @param block configuration section
* @param error location to store the error occurring, or nullptr to
* ignore errors.
* @return a new filter object, or nullptr on error
@@ -56,7 +56,7 @@ filter_new(const struct filter_plugin *plugin,
* Creates a new filter, loads configuration and the plugin name from
* the specified configuration section.
*
- * @param param the configuration section
+ * @param block the configuration section
* @param error location to store the error occurring, or nullptr to
* ignore errors.
* @return a new filter object, or nullptr on error
diff --git a/src/filter/plugins/ReplayGainFilterPlugin.hxx b/src/filter/plugins/ReplayGainFilterPlugin.hxx
index 6c20aa872..ec0cafc60 100644
--- a/src/filter/plugins/ReplayGainFilterPlugin.hxx
+++ b/src/filter/plugins/ReplayGainFilterPlugin.hxx
@@ -38,9 +38,9 @@ replay_gain_filter_set_mixer(Filter *_filter, Mixer *mixer,
unsigned base);
/**
- * Sets a new #replay_gain_info at the beginning of a new song.
+ * Sets a new #ReplayGainInfo at the beginning of a new song.
*
- * @param info the new #replay_gain_info value, or nullptr if no replay
+ * @param info the new #ReplayGainInfo value, or nullptr if no replay
* gain data is available for the current song
*/
void