*: 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

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

View File

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

View File

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

View File

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

View File

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

View File

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