# HG changeset patch # User alpar # Date 1083157138 0 # Node ID 2df1fee6c866a58f7d7f6c2a12c3d98200a9cfd7 # Parent 8fbd472b1a22afa4260fa0995910c2ed0ce111f9 Docs. diff -r 8fbd472b1a22 -r 2df1fee6c866 src/include/time_measure.h --- a/src/include/time_measure.h Wed Apr 28 12:33:05 2004 +0000 +++ b/src/include/time_measure.h Wed Apr 28 12:58:58 2004 +0000 @@ -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; diff -r 8fbd472b1a22 -r 2df1fee6c866 src/include/xy.h --- a/src/include/xy.h Wed Apr 28 12:33:05 2004 +0000 +++ b/src/include/xy.h Wed Apr 28 12:58:58 2004 +0000 @@ -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 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 class BoundingBox { xy bottom_left, top_right;