Doxygen tweaks.

diff --git a/Doxyfile b/Doxyfile
index 3058d669bb1651aed445a391ca23b7ceb5849b6e..475f6ed15166ec98e971cebfdaffb5e4172d8187 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -822,7 +822,7 @@ EXCLUDE_PATTERNS       =
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories use the pattern */test/*
 
-EXCLUDE_SYMBOLS        =
+EXCLUDE_SYMBOLS        = dcp::data::* *ASDCPState dcp::*::ParseState *ASDCPStateBase SubtitleSorter
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or directories
 # that contain example code fragments that are included (see the \include

diff --git a/src/dcp_time.h b/src/dcp_time.h
index c5d0186e4cf88ab0614924c82f7208a9a458b211..88a4d8a10b75ac3d606478d7a56b546c0284bda3 100644 (file)
--- a/src/dcp_time.h
+++ b/src/dcp_time.h
@@ -39,8 +39,10 @@ public:
        /** Construct a zero Time */
        Time () : h (0), m (0), s (0), e (0), tcr (1) {}
 
-       /** Construct a Time from a frame index (starting from 0),
-        *  a frames per second count and a timecode rate.
+       /** Construct a Time.
+        *  @param Frame index (starting from 0).
+        *  @param frames_per_second Frames per second.
+        *  @param tcr Timecode rate.
         */
        Time (int frame, int frames_per_second, int tcr);
 

diff --git a/src/font.cc b/src/font.cc
index 0df81e9d0954fd499c42fd611dc378a2fbe600de..cbfb999a47ef6be4db642c802ae79f6da92e45d9 100644 (file)
--- a/src/font.cc
+++ b/src/font.cc
@@ -17,6 +17,10 @@
 
 */
 
+/** @file  src/font.cc
+ *  @brief Font class.
+ */
+
 #include "font.h"
 
 using std::string;

diff --git a/src/font.h b/src/font.h
index 490d54076f4b010b5d5298f89b43fa7e5ec422a6..8e0b4e188eb0d623c86a27bd1ff49018adc129ea 100644 (file)
--- a/src/font.h
+++ b/src/font.h
@@ -18,13 +18,16 @@
 */
 
 /** @file  src/font.h
- *  @brief A (truetype) font asset for subtitles in a DCP.
+ *  @brief Font class.
  */
 
 #include "asset.h"
 
 namespace dcp {
 
+/** @class Font
+ *  @brief A (truetype) font asset for subtitles in a DCP.
+ */
 class Font : public Asset
 {
 public:

diff --git a/src/font_node.h b/src/font_node.h
index 2149e883392dd575d06a8d17866cf1ac38090913..60005218e7b86c34b183a87c5af54b3205ae16a6 100644 (file)
--- a/src/font_node.h
+++ b/src/font_node.h
@@ -30,7 +30,7 @@
 
 namespace dcp {
 
-/** @class Font
+/** @class FontNode
  *  @brief Helper class for parsing subtitle XML.
  */
 class FontNode

diff --git a/src/metadata.cc b/src/metadata.cc
index a77878bb2fb6d2d4035e80625ff36a1615e13362..8d8abc60f625165d6091c4eca668ccddd4d0f385 100644 (file)
--- a/src/metadata.cc
+++ b/src/metadata.cc
@@ -55,6 +55,7 @@ XMLMetadata::XMLMetadata ()
        set_issue_date_now ();
 }
 
+/** Set the issue date to the current local time */
 void
 XMLMetadata::set_issue_date_now ()
 {

diff --git a/src/picture_asset_writer_common.cc b/src/picture_asset_writer_common.cc
index 9b46e55e225c2b30d88b4bff44f5320d321c86e1..0696bc4862df40e4975226f01c9ec799f99354e7 100644 (file)
--- a/src/picture_asset_writer_common.cc
+++ b/src/picture_asset_writer_common.cc
@@ -19,6 +19,8 @@
 
 using boost::shared_ptr;
 
+namespace dcp {
+
 struct ASDCPStateBase
 {
        ASDCPStateBase ()
@@ -31,6 +33,8 @@ struct ASDCPStateBase
        ASDCP::JP2K::PictureDescriptor picture_descriptor;
 };
 
+}
+
 template <class P, class Q>
 void dcp::start (PictureAssetWriter* writer, shared_ptr<P> state, Standard standard, Q* asset, uint8_t* data, int size)
 {

diff --git a/src/reel_asset.h b/src/reel_asset.h
index 118f10a126bc50ccc98bce98337c00db4fa78f57..47bae6752dc7d29dd76abe92dc74f209ab7e4cfe 100644 (file)
--- a/src/reel_asset.h
+++ b/src/reel_asset.h
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2015 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/reel_asset.h
+ *  @brief ReelAsset class.
+ */
+
 #ifndef LIBDCP_REEL_ASSET_H
 #define LIBDCP_REEL_ASSET_H
 
@@ -84,7 +88,6 @@ protected:
        Ref<Asset> _asset_ref;
 
 private:
-       
        std::string _annotation_text; ///< The &lt;AnnotationText&gt; from the reel's entry for this asset
        Fraction _edit_rate;          ///< The &lt;EditRate&gt; from the reel's entry for this asset
        int64_t _intrinsic_duration;  ///< The &lt;IntrinsicDuration&gt; from the reel's entry for this asset

diff --git a/src/types.h b/src/types.h
index ca7603abdbad9d5df1480d49edcf7dd9bd9b421e..16908952a58c135d06c0fce3d42c0eec62fa291d 100644 (file)
--- a/src/types.h
+++ b/src/types.h
@@ -172,9 +172,9 @@ struct EqualityOptions
        double max_std_dev_pixel_error;
        /** The maximum difference in audio sample value between two soundtracks */
        int max_audio_sample_error;
-       /** true if the <AnnotationText> nodes of CPLs are allowed to differ */
+       /** true if the &lt;AnnotationText&gt; nodes of CPLs are allowed to differ */
        bool cpl_annotation_texts_can_differ;
-       /** true if the <AnnotationText> nodes of Reels are allowed to differ */
+       /** true if the &lt;AnnotationText&gt; nodes of Reels are allowed to differ */
        bool reel_annotation_texts_can_differ;
        /** true if <Hash>es in Reels can differ */
        bool reel_hashes_can_differ;