From: Carl Hetherington <cth@carlh.net>
Date: Sun, 7 Jun 2015 23:32:50 +0000 (+0100)
Subject: Doxygen tweaks.
X-Git-Tag: v1.1.0~18
X-Git-Url: https://git.carlh.net/gitweb/?a=commitdiff_plain;h=635c3ae7aee1cad4b871fcf0ddf02a8be1cdce78;p=libdcp.git

Doxygen tweaks.
---

diff --git a/Doxyfile b/Doxyfile
index 3058d669..475f6ed1 100644
--- 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 c5d0186e..88a4d8a1 100644
--- 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 0df81e9d..cbfb999a 100644
--- 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 490d5407..8e0b4e18 100644
--- 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 2149e883..60005218 100644
--- 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 a77878bb..8d8abc60 100644
--- 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 9b46e55e..0696bc48 100644
--- 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 118f10a1..47bae675 100644
--- 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 ca7603ab..16908952 100644
--- 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;