[Lemon-commits] [lemon_svn] alpar: r606 - hugo/trunk/src/include

[Lemon SVN]

Author: alpar
Date: Wed Apr 28 14:58:58 2004
New Revision: 606

Modified:
   hugo/trunk/src/include/time_measure.h
   hugo/trunk/src/include/xy.h

Log:
Docs.


Modified: hugo/trunk/src/include/time_measure.h
==============================================================================
--- hugo/trunk/src/include/time_measure.h	(original)
+++ hugo/trunk/src/include/time_measure.h	Wed Apr 28 14:58:58 2004
@@ -28,6 +28,10 @@
   ///
   /// TimeStamp's can be added to or substracted from each other and
   /// they can be pushed to a stream.
+  ///
+  /// In most cases, perhaps \ref Timer class is what you want to use instead.
+  ///
+  ///\author Alpar Juttner
 
   class TimeStamp
   {
@@ -119,6 +123,30 @@
   };
 
   ///Class measuring the cpu time and real time usage of the process
+
+  ///Class measuring the cpu time and real time usage of the process.
+  ///It is quite easy-to-use, here is a short example.
+  ///\code
+  ///int main()
+  ///{
+  ///
+  ///  ...
+  ///
+  ///  Timer T();
+  ///  doSomething();
+  ///  cout << T;
+  ///  T.reset();
+  ///  doSomethingElse();
+  ///  cout << T;
+  ///
+  ///  ...
+  ///
+  ///}
+  ///\endcode
+  ///
+  ///\todo This shouldn't be Unix (Linux) specific.
+  ///
+  ///\author Alpar Juttner
   class Timer
   {
     TimeStamp start_time;

Modified: hugo/trunk/src/include/xy.h
==============================================================================
--- hugo/trunk/src/include/xy.h	(original)
+++ hugo/trunk/src/include/xy.h	Wed Apr 28 14:58:58 2004
@@ -14,6 +14,8 @@
 ///
 /// The class \ref hugo::BoundingBox "BoundingBox" can be used to determine
 /// the rectangular bounding box a set of \ref hugo::xy "xy"'s.
+///
+///\author Attila Bernath
 
 
 namespace hugo {
@@ -21,10 +23,13 @@
   /// \addtogroup misc
   /// @{
 
-/** \brief
-2 dimensional vector (plainvector) implementation
+  /// A two dimensional vector (plainvector) implementation
 
-*/
+  /// A two dimensional vector (plainvector) implementation
+  ///with the usual vector
+  /// operators.
+  ///
+  ///\author Attila Bernath
   template<typename T>
     class xy {
 
@@ -133,10 +138,11 @@
   }
 
 
-  /** \brief
-     Implementation of a bounding box of plainvectors.
-     
-  */
+  /// A class to calculate or store the bounding box of plainvectors.
+
+  /// A class to calculate or store the bounding box of plainvectors.
+  ///
+  ///\author Attila Bernath
   template<typename T>
     class BoundingBox {
       xy<T> bottom_left, top_right;