summaryrefslogtreecommitdiff
path: root/src/lib/processor.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2012-11-19 00:07:29 +0000
committerCarl Hetherington <cth@carlh.net>2012-11-19 00:07:29 +0000
commit259ed1f1602d866640a3035341a834e937e45e79 (patch)
tree12513a92e881f1f76bb19dec535137ebc66ef7b9 /src/lib/processor.h
parent52b840565b8be0f4933b78948bddeccfc4ba2135 (diff)
Remove unused Processor::process_begin; some docs.
Diffstat (limited to 'src/lib/processor.h')
-rw-r--r--src/lib/processor.h18
1 files changed, 15 insertions, 3 deletions
diff --git a/src/lib/processor.h b/src/lib/processor.h
index cddcbf3f1..e632f813f 100644
--- a/src/lib/processor.h
+++ b/src/lib/processor.h
@@ -37,15 +37,18 @@ class Log;
class Processor
{
public:
+ /** Construct a Processor.
+ * @param log Log to use.
+ */
Processor (Log* log)
: _log (log)
{}
-
- virtual void process_begin () {}
+
+ /** Will be called at the end of a processing run */
virtual void process_end () {}
protected:
- Log* _log;
+ Log* _log; ///< log to write to
};
/** @class AudioVideoProcessor
@@ -54,6 +57,9 @@ protected:
class AudioVideoProcessor : public Processor, public VideoSource, public VideoSink, public AudioSource, public AudioSink
{
public:
+ /** Construct an AudioVideoProcessor.
+ * @param log Log to write to.
+ */
AudioVideoProcessor (Log* log)
: Processor (log)
{}
@@ -65,6 +71,9 @@ public:
class AudioProcessor : public Processor, public AudioSource, public AudioSink
{
public:
+ /** Construct an AudioProcessor.
+ * @param log Log to write to.
+ */
AudioProcessor (Log* log)
: Processor (log)
{}
@@ -76,6 +85,9 @@ public:
class VideoProcessor : public Processor, public VideoSource, public VideoSink
{
public:
+ /** Construct an VideoProcessor.
+ * @param log Log to write to.
+ */
VideoProcessor (Log* log)
: Processor (log)
{}