Changeset 1369 for branches/0.4-stable/yat

Timestamp:

Jul 11, 2008, 6:10:03 PM (15 years ago)

Author:

Peter

Message:

documenting some magic functionality I didn't know existed

File:

• branches/0.4-stable/yat/utility/VectorBase.h (modified) (1 diff)

branches/0.4-stable/yat/utility/VectorBase.h

@@ -249 +249 @@
   /**
      \brief The output operator for the VectorBase class.
-  */
-  std::ostream& operator<<(std::ostream&, const VectorBase&);
+
+     Elements in VectorBase \a v are sent to ostream \a s and
+     separated with the fill character of stream \a s, s.fill(). If
+     you, for example, want to print the VectorBase \a v with the
+     elements separated by a ':', you do so by:
+     \verbatim 
+     s << setfill(':') << v; 
+     \endverbatim
+  */
+  std::ostream& operator<<(std::ostream& s, const VectorBase& v);
 
 }}} // of namespace utility, yat, and theplu