summaryrefslogtreecommitdiff
path: root/src/lib/content.h
diff options
context:
space:
mode:
authorCarl Hetherington <cth@carlh.net>2014-05-02 20:13:38 +0100
committerCarl Hetherington <cth@carlh.net>2014-05-02 20:13:38 +0100
commit26daeb63ed25a161a3911d715a04535a102d632a (patch)
tree39d7b9ad3ffb99172b6f6574aeb0effcfb927a76 /src/lib/content.h
parent2f61270d2726445f562efc0e4b33fa19ba235183 (diff)
Comments.
Diffstat (limited to 'src/lib/content.h')
-rw-r--r--src/lib/content.h13
1 files changed, 10 insertions, 3 deletions
diff --git a/src/lib/content.h b/src/lib/content.h
index fc3a531fa..659995b3b 100644
--- a/src/lib/content.h
+++ b/src/lib/content.h
@@ -1,5 +1,5 @@
/*
- Copyright (C) 2013 Carl Hetherington <cth@carlh.net>
+ Copyright (C) 2013-2014 Carl Hetherington <cth@carlh.net>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -17,6 +17,10 @@
*/
+/** @file src/lib/content.h
+ * @brief Content class.
+ */
+
#ifndef DCPOMATIC_CONTENT_H
#define DCPOMATIC_CONTENT_H
@@ -46,6 +50,9 @@ public:
static int const TRIM_END;
};
+/** @class Content
+ * @brief A piece of content represented by one or more files on disk.
+ */
class Content : public boost::enable_shared_from_this<Content>, public boost::noncopyable
{
public:
@@ -138,8 +145,8 @@ protected:
boost::weak_ptr<const Film> _film;
/** _mutex which should be used to protect accesses, as examine
- jobs can update content state in threads other than the main one.
- */
+ * jobs can update content state in threads other than the main one.
+ */
mutable boost::mutex _mutex;
/** Paths of our data files */