diff options
| author | Max Kellermann <max@duempel.org> | 2015-03-17 11:21:29 +0100 |
|---|---|---|
| committer | Max Kellermann <max@duempel.org> | 2015-03-17 11:21:43 +0100 |
| commit | b31d171ae87dabe8026934c60b1a1195dddd32a2 (patch) | |
| tree | a2ccb96a730049950f1f94df22b9147220dd16fc /src/AudioFormat.hxx | |
| parent | 085f06594c38333536040d19eec21240cf98b12c (diff) | |
*: doxygen fixups
Diffstat (limited to 'src/AudioFormat.hxx')
| -rw-r--r-- | src/AudioFormat.hxx | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/src/AudioFormat.hxx b/src/AudioFormat.hxx index c83e0fda4..a00e761a8 100644 --- a/src/AudioFormat.hxx +++ b/src/AudioFormat.hxx @@ -99,8 +99,8 @@ struct AudioFormat { } /** - * Clears the #audio_format object, i.e. sets all attributes to an - * undefined (invalid) value. + * Clears the object, i.e. sets all attributes to an undefined + * (invalid) value. */ void Clear() { sample_rate = 0; @@ -185,8 +185,6 @@ audio_valid_sample_rate(unsigned sample_rate) /** * Checks whether the sample format is valid. - * - * @param bits the number of significant bits per sample */ static inline bool audio_valid_sample_format(SampleFormat format) @@ -289,10 +287,10 @@ AudioFormat::GetTimeToSize() const } /** - * Renders a #sample_format enum into a string, e.g. for printing it + * Renders a #SampleFormat enum into a string, e.g. for printing it * in a log file. * - * @param format a #sample_format enum value + * @param format a #SampleFormat enum value * @return the string */ gcc_pure gcc_malloc @@ -300,12 +298,12 @@ const char * sample_format_to_string(SampleFormat format); /** - * Renders the #audio_format object into a string, e.g. for printing + * Renders the #AudioFormat object into a string, e.g. for printing * it in a log file. * - * @param af the #audio_format object + * @param af the #AudioFormat object * @param s a buffer to print into - * @return the string, or nullptr if the #audio_format object is invalid + * @return the string, or nullptr if the #AudioFormat object is invalid */ gcc_pure gcc_malloc const char * |