summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/processor.h
diff options
context:
space:
mode:
authorCarl Hetherington <carl@carlh.net>2011-05-25 10:15:54 +0000
committerCarl Hetherington <carl@carlh.net>2011-05-25 10:15:54 +0000
commitb38b5fd59b6022177f14fe29c18eb49fce3ca579 (patch)
tree7579e1278a02525d3669396c43271cd3c59a41f2 /libs/ardour/ardour/processor.h
parente5dc4e4ea2cd4f2a91f77464980db52fd4df6b86 (diff)
Doxygen tweaks.
git-svn-id: svn://localhost/ardour2/branches/3.0@9581 d708f5d6-7413-0410-9779-e7cbd77b26cf
Diffstat (limited to 'libs/ardour/ardour/processor.h')
-rw-r--r--libs/ardour/ardour/processor.h9
1 files changed, 4 insertions, 5 deletions
diff --git a/libs/ardour/ardour/processor.h b/libs/ardour/ardour/processor.h
index 94b9363480..05f7dd4fb1 100644
--- a/libs/ardour/ardour/processor.h
+++ b/libs/ardour/ardour/processor.h
@@ -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;
};