Some Doxygen comments.

[libsub.git] / src / dcp_reader.cc

diff --git a/src/dcp_reader.cc b/src/dcp_reader.cc
index a5fdd004315387fb72825671017caf424c9065c0..b938b6cc8263c1fca2cc07965a2da8406de3a2c1 100644 (file)
--- a/src/dcp_reader.cc
+++ b/src/dcp_reader.cc
@@ -39,6 +39,9 @@ namespace sub {
 
 class DCPFont;
 
+/** @class DCPText
+ *  @brief A DCP subtitle <Text> node.
+ */
 class DCPText
 {
 public:
@@ -67,6 +70,9 @@ public:
        list<shared_ptr<DCPFont> > font_nodes;
 };
 
+/** @class DCPSubtitle
+ *  @brief A DCP subtitle &lt;Subtitle&gt; node.
+ */
 class DCPSubtitle 
 {
 public:
@@ -121,6 +127,9 @@ private:
        }
 };
 
+/** @class DCPFont
+ *  @brief A DCP subtitle &lt;Font&gt; node.
+ */
 class DCPFont 
 {
 public:
@@ -193,6 +202,9 @@ public:
        list<shared_ptr<DCPText> > text_nodes;
 };
 
+/** @class DCPLoadFont
+ *  @brief A DCP subtitle &lt;LoadFont&gt; node.
+ */
 class DCPLoadFont 
 {
 public:
@@ -207,6 +219,9 @@ public:
        string uri;
 };
 
+/** @class DCPReader::ParseState
+ *  @brief Holder of state for use while reading DCP subtitles.
+ */
 struct DCPReader::ParseState {
        list<shared_ptr<DCPFont> > font_nodes;
        list<shared_ptr<DCPText> > text_nodes;
@@ -249,6 +264,9 @@ DCPReader::font_id_to_name (string id) const
        return (*i)->uri;
 }
 
+/** @class DCPReader
+ *  @brief A class to read DCP subtitles.
+ */
 DCPReader::DCPReader (istream& in)
 {
        shared_ptr<cxml::Document> xml (new cxml::Document ("DCSubtitle"));