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/pcm | |
parent | 085f06594c38333536040d19eec21240cf98b12c (diff) |
*: doxygen fixups
Diffstat (limited to 'src/pcm')
-rw-r--r-- | src/pcm/PcmConvert.hxx | 5 | ||||
-rw-r--r-- | src/pcm/PcmDither.hxx | 6 | ||||
-rw-r--r-- | src/pcm/PcmExport.hxx | 2 | ||||
-rw-r--r-- | src/pcm/PcmFormat.hxx | 16 | ||||
-rw-r--r-- | src/pcm/PcmPack.hxx | 2 | ||||
-rw-r--r-- | src/pcm/Resampler.hxx | 5 |
6 files changed, 11 insertions, 25 deletions
diff --git a/src/pcm/PcmConvert.hxx b/src/pcm/PcmConvert.hxx index 716ac9e05..1f5e41bc6 100644 --- a/src/pcm/PcmConvert.hxx +++ b/src/pcm/PcmConvert.hxx @@ -74,11 +74,8 @@ public: /** * Converts PCM data between two audio formats. * - * @param src_format the source audio format * @param src the source PCM buffer - * @param dest_format the requested destination audio format - * @param error_r location to store the error occurring, or nullptr to - * ignore errors + * @param error location to store the error occurring * @return the destination buffer, or nullptr on error */ ConstBuffer<void> Convert(ConstBuffer<void> src, Error &error); diff --git a/src/pcm/PcmDither.hxx b/src/pcm/PcmDither.hxx index 86d844eae..491f22601 100644 --- a/src/pcm/PcmDither.hxx +++ b/src/pcm/PcmDither.hxx @@ -36,9 +36,9 @@ public: * Shift the given sample by #SBITS-#DBITS to the right, and * apply dithering. * - * @param ST the input sample type - * @param SBITS the input bit width - * @param DBITS the output bit width + * @tparam ST the input sample type + * @tparam SBITS the input bit width + * @tparam DBITS the output bit width * @param sample the input sample value */ template<typename ST, unsigned SBITS, unsigned DBITS> diff --git a/src/pcm/PcmExport.hxx b/src/pcm/PcmExport.hxx index c174437cc..7265ca07d 100644 --- a/src/pcm/PcmExport.hxx +++ b/src/pcm/PcmExport.hxx @@ -86,7 +86,7 @@ struct PcmExport { uint8_t reverse_endian; /** - * Open the #pcm_export_state object. + * Open the object. * * There is no "close" method. This function may be called multiple * times to reuse the object. diff --git a/src/pcm/PcmFormat.hxx b/src/pcm/PcmFormat.hxx index cc6db2c8d..9d15011a7 100644 --- a/src/pcm/PcmFormat.hxx +++ b/src/pcm/PcmFormat.hxx @@ -33,9 +33,8 @@ class PcmDither; * Converts PCM samples to 16 bit. If the source format is 24 bit, * then dithering is applied. * - * @param buffer a PcmBuffer object - * @param dither a pcm_dither object for 24-to-16 conversion - * @param bits the number of in the source buffer + * @param buffer a #PcmBuffer object + * @param dither a #PcmDither object for 24-to-16 conversion * @param src the source PCM buffer * @return the destination buffer */ @@ -47,8 +46,7 @@ pcm_convert_to_16(PcmBuffer &buffer, PcmDither &dither, /** * Converts PCM samples to 24 bit (32 bit alignment). * - * @param buffer a PcmBuffer object - * @param bits the number of in the source buffer + * @param buffer a #PcmBuffer object * @param src the source PCM buffer * @return the destination buffer */ @@ -60,8 +58,7 @@ pcm_convert_to_24(PcmBuffer &buffer, /** * Converts PCM samples to 32 bit. * - * @param buffer a PcmBuffer object - * @param bits the number of in the source buffer + * @param buffer a #PcmBuffer object * @param src the source PCM buffer * @return the destination buffer */ @@ -73,11 +70,8 @@ pcm_convert_to_32(PcmBuffer &buffer, /** * Converts PCM samples to 32 bit floating point. * - * @param buffer a PcmBuffer object - * @param bits the number of in the source buffer + * @param buffer a #PcmBuffer object * @param src the source PCM buffer - * @param src_size the size of #src in bytes - * @param dest_size_r returns the number of bytes of the destination buffer * @return the destination buffer */ gcc_pure diff --git a/src/pcm/PcmPack.hxx b/src/pcm/PcmPack.hxx index 613298e2e..e05601986 100644 --- a/src/pcm/PcmPack.hxx +++ b/src/pcm/PcmPack.hxx @@ -35,7 +35,6 @@ * * @param dest the destination buffer (array of triples) * @param src the source buffer - * @param num_samples the number of samples to convert */ void pcm_pack_24(uint8_t *dest, const int32_t *src, const int32_t *src_end); @@ -46,7 +45,6 @@ pcm_pack_24(uint8_t *dest, const int32_t *src, const int32_t *src_end); * * @param dest the destination buffer * @param src the source buffer (array of triples) - * @param num_samples the number of samples to convert */ void pcm_unpack_24(int32_t *dest, const uint8_t *src, const uint8_t *src_end); diff --git a/src/pcm/Resampler.hxx b/src/pcm/Resampler.hxx index 5525b6cda..75f91b6ab 100644 --- a/src/pcm/Resampler.hxx +++ b/src/pcm/Resampler.hxx @@ -58,10 +58,7 @@ public: * Resamples a block of PCM data. * * @param src the input buffer - * @param src_size the size of #src_buffer in bytes - * @param dest_size_r the size of the returned 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 filter_close() or filter_filter()), nullptr on * error |