[yoda-svn] yoda: Comments

[YODA Mercurial]

details:   https://yoda.hepforge.org/hg/yoda/rev/514643311c9a
branches:  
changeset: 1418:514643311c9a
user:      Andy Buckley <andy at insectnation.org>
date:      Tue Oct 03 17:17:04 2017 +0100
description:
Comments

diffs (20 lines):

--- a/include/YODA/Writer.h	Mon Oct 02 11:25:18 2017 +0200
+++ b/include/YODA/Writer.h	Tue Oct 03 17:17:04 2017 +0100
@@ -68,11 +68,15 @@
     /// @name Writing multiple analysis objects by collection.
     //@{
 
-    /// The canonical writing is implemented as a vector of AO pointers
+    /// Write out a vector of AO pointers (untemplated=exact type-match) to the given stream
     ///
-    /// @note Among other reasons, this is to hide zstr from the public API
+    /// @note This is the canonical function for implementing AO writing: all
+    /// others call this. Hence the specific AOs type.
+    ///
+    /// @note Among other reasons, this is non-inline to hide zstr from the public API
     void write(std::ostream& stream, const std::vector<const AnalysisObject*>& aos);
 
+
     /// Write out a collection of objects @a objs to output stream @a stream.
     ///
     /// @note The enable_if call checks whether RANGE is const_iterable, if yes the return