ardour/livetrax
13
0
Fork 0
Code

Doxygen tweaks.

Browse Source 
git-svn-id: svn://localhost/ardour2/branches/3.0@9581 d708f5d6-7413-0410-9779-e7cbd77b26cf
This commit is contained in:
Carl Hetherington 2011-05-25 10:15:54 +00:00
parent e5dc4e4ea2
commit b38b5fd59b
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
libs/ardour/ardour/audio_buffer.h
View File

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

9
libs/ardour/ardour/processor.h
View File

@ -40,8 +40,7 @@ namespace ARDOUR {
class Session;
class Route;
/* A mixer strip element - plugin, send, meter, etc.
*/
/** A mixer strip element - plugin, send, meter, etc */
class Processor : public SessionObject, public Automatable, public Latent
{
public:
@ -67,8 +66,8 @@ class Processor : public SessionObject, public Automatable, public Latent
virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
virtual bool requires_fixed_sized_buffers() const { return false; }
/** @param result_required true if, on return from this method, bufs is required to contain valid data;
* if false, the method need not bother writing to bufs if it doesn't want to.
/** @param result_required true if, on return from this method, @a bufs is required to contain valid data;
* if false, the method need not bother writing to @a bufs if it doesn't want to.
*/
virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t /*nframes*/, bool /*result_required*/) {}
virtual void silence (framecnt_t /*nframes*/) {}
@ -114,7 +113,7 @@ protected:
ChanCount _configured_input;
ChanCount _configured_output;
bool _display_to_user;
bool _pre_fader;
bool _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
void* _ui_pointer;
};

2
libs/ardour/processor.cc
View File

@ -265,7 +265,7 @@ Processor::set_state (const XMLNode& node, int version)
return 0;
}
/** Caller must hold process lock */
/** @pre Caller must hold process lock */
bool
Processor::configure_io (ChanCount in, ChanCount out)
{