[yoda-svn] r551 - in trunk: . include/YODA

[blackhole at projects.hepforge.org]

Author: buckley
Date: Tue Nov 27 16:44:58 2012
New Revision: 551

Log:
Doxygen tweaks to hide the horrors of the ReaderYODA parsing implementation!

Modified:
   trunk/Doxyfile.in
   trunk/include/YODA/ReaderYODA.h

Modified: trunk/Doxyfile.in
==============================================================================
--- trunk/Doxyfile.in	Tue Nov 27 15:30:09 2012	(r550)
+++ trunk/Doxyfile.in	Tue Nov 27 16:44:58 2012	(r551)
@@ -632,7 +632,7 @@
 # excluded from the INPUT source files. This way you can easily exclude a
 # subdirectory from a directory tree whose root is specified with the INPUT tag.
 
-EXCLUDE                = src/tinyxml
+EXCLUDE                = src/tinyxml  src/ReaderYODA.cc
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

Modified: trunk/include/YODA/ReaderYODA.h
==============================================================================
--- trunk/include/YODA/ReaderYODA.h	Tue Nov 27 15:30:09 2012	(r550)
+++ trunk/include/YODA/ReaderYODA.h	Tue Nov 27 16:44:58 2012	(r551)
@@ -34,6 +34,11 @@
       _readDoc(stream, aos);
     }
 
+
+    // Hide from Doxygen until endcond
+    /// @cond
+
+
   protected:
 
     void _readDoc(std::istream& stream, std::vector<AnalysisObject*>& aos);
@@ -59,12 +64,11 @@
   public:
 
     /// Private constructor, since it's a singleton.
+    /// @todo This is definitely not private!
     ReaderYODA() { }
 
 
-
-    /// Here comes everything we need for the parser
-
+    // Here comes everything we need for the parser
 
     /// Structs for the Histo1D parser
     /// The data for Dbn1D
@@ -324,14 +328,20 @@
       qi::rule<Iterator, scatterpoint2d(), Skipper> ScatterPoint2D;
     };
 
+
+    /// @endcond
+
   };
 
 } // end of YODA namespace
 
 
-/// Now we need to make boost aware of the structs we want to
-/// fill directly from the parser. Boost wants this magic in
-/// the global scope, that's why we have it outside the namespace.
+
+// Now we need to make boost aware of the structs we want to
+// fill directly from the parser. Boost wants this magic in
+// the global scope, that's why we have it outside the namespace.
+
+/// @cond PRIVATE
 
 BOOST_FUSION_ADAPT_STRUCT(
   YODA::ReaderYODA::histo1ddbn,
@@ -383,6 +393,6 @@
   (std::string, val)
 )
 
-
+/// @endcond
 
 #endif