*: doxygen fixups

This commit is contained in:
Max Kellermann
2015-03-17 11:21:29 +01:00
parent 085f06594c
commit b31d171ae8
37 changed files with 55 additions and 106 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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