From b31d171ae87dabe8026934c60b1a1195dddd32a2 Mon Sep 17 00:00:00 2001 From: Max Kellermann Date: Tue, 17 Mar 2015 11:21:29 +0100 Subject: *: doxygen fixups --- src/filter/FilterConfig.hxx | 2 +- src/filter/FilterInternal.hxx | 8 ++------ src/filter/FilterPlugin.hxx | 4 ++-- src/filter/plugins/ReplayGainFilterPlugin.hxx | 4 ++-- 4 files changed, 7 insertions(+), 11 deletions(-) (limited to 'src/filter') 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 -- cgit v1.2.3