Docs.
1.1 --- a/src/include/time_measure.h Wed Apr 28 12:33:05 2004 +0000
1.2 +++ b/src/include/time_measure.h Wed Apr 28 12:58:58 2004 +0000
1.3 @@ -28,6 +28,10 @@
1.4 ///
1.5 /// TimeStamp's can be added to or substracted from each other and
1.6 /// they can be pushed to a stream.
1.7 + ///
1.8 + /// In most cases, perhaps \ref Timer class is what you want to use instead.
1.9 + ///
1.10 + ///\author Alpar Juttner
1.11
1.12 class TimeStamp
1.13 {
1.14 @@ -119,6 +123,30 @@
1.15 };
1.16
1.17 ///Class measuring the cpu time and real time usage of the process
1.18 +
1.19 + ///Class measuring the cpu time and real time usage of the process.
1.20 + ///It is quite easy-to-use, here is a short example.
1.21 + ///\code
1.22 + ///int main()
1.23 + ///{
1.24 + ///
1.25 + /// ...
1.26 + ///
1.27 + /// Timer T();
1.28 + /// doSomething();
1.29 + /// cout << T;
1.30 + /// T.reset();
1.31 + /// doSomethingElse();
1.32 + /// cout << T;
1.33 + ///
1.34 + /// ...
1.35 + ///
1.36 + ///}
1.37 + ///\endcode
1.38 + ///
1.39 + ///\todo This shouldn't be Unix (Linux) specific.
1.40 + ///
1.41 + ///\author Alpar Juttner
1.42 class Timer
1.43 {
1.44 TimeStamp start_time;
2.1 --- a/src/include/xy.h Wed Apr 28 12:33:05 2004 +0000
2.2 +++ b/src/include/xy.h Wed Apr 28 12:58:58 2004 +0000
2.3 @@ -14,6 +14,8 @@
2.4 ///
2.5 /// The class \ref hugo::BoundingBox "BoundingBox" can be used to determine
2.6 /// the rectangular bounding box a set of \ref hugo::xy "xy"'s.
2.7 +///
2.8 +///\author Attila Bernath
2.9
2.10
2.11 namespace hugo {
2.12 @@ -21,10 +23,13 @@
2.13 /// \addtogroup misc
2.14 /// @{
2.15
2.16 -/** \brief
2.17 -2 dimensional vector (plainvector) implementation
2.18 + /// A two dimensional vector (plainvector) implementation
2.19
2.20 -*/
2.21 + /// A two dimensional vector (plainvector) implementation
2.22 + ///with the usual vector
2.23 + /// operators.
2.24 + ///
2.25 + ///\author Attila Bernath
2.26 template<typename T>
2.27 class xy {
2.28
2.29 @@ -133,10 +138,11 @@
2.30 }
2.31
2.32
2.33 - /** \brief
2.34 - Implementation of a bounding box of plainvectors.
2.35 -
2.36 - */
2.37 + /// A class to calculate or store the bounding box of plainvectors.
2.38 +
2.39 + /// A class to calculate or store the bounding box of plainvectors.
2.40 + ///
2.41 + ///\author Attila Bernath
2.42 template<typename T>
2.43 class BoundingBox {
2.44 xy<T> bottom_left, top_right;