diff options
| author | Carl Hetherington <carl@carlh.net> | 2011-05-25 10:15:54 +0000 |
|---|---|---|
| committer | Carl Hetherington <carl@carlh.net> | 2011-05-25 10:15:54 +0000 |
| commit | b38b5fd59b6022177f14fe29c18eb49fce3ca579 (patch) | |
| tree | 7579e1278a02525d3669396c43271cd3c59a41f2 /libs/ardour/ardour/audio_buffer.h | |
| parent | e5dc4e4ea2cd4f2a91f77464980db52fd4df6b86 (diff) | |
Doxygen tweaks.
git-svn-id: svn://localhost/ardour2/branches/3.0@9581 d708f5d6-7413-0410-9779-e7cbd77b26cf
Diffstat (limited to 'libs/ardour/ardour/audio_buffer.h')
| -rw-r--r-- | libs/ardour/ardour/audio_buffer.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/libs/ardour/ardour/audio_buffer.h b/libs/ardour/ardour/audio_buffer.h index 10f5f27ec3..a0f854b0eb 100644 --- a/libs/ardour/ardour/audio_buffer.h +++ b/libs/ardour/ardour/audio_buffer.h @@ -24,6 +24,7 @@ namespace ARDOUR { +/** Buffer containing audio data. */ class AudioBuffer : public Buffer { public: @@ -57,14 +58,14 @@ public: _written = true; } - /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset*/ + /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @a dst_offset */ void merge_from (const Buffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) { const AudioBuffer* ab = dynamic_cast<const AudioBuffer*>(&src); assert (ab); accumulate_from (*ab, len, dst_offset, src_offset); } - /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset*/ + /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @a dst_offset */ void accumulate_from (const AudioBuffer& src, framecnt_t len, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) { assert(_capacity > 0); assert(len <= _capacity); @@ -78,7 +79,7 @@ public: _written = true; } - /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @ dst_offset + /** Acumulate (add) @a len frames @a src starting at @a src_offset into self starting at @dst_offset * scaling by @a gain_coeff */ void accumulate_with_gain_from (const AudioBuffer& src, framecnt_t len, gain_t gain_coeff, framecnt_t dst_offset = 0, framecnt_t src_offset = 0) { |