Improve docs.
authoralpar
Tue, 07 Sep 2004 10:56:37 +0000
changeset 814d2d747fe1db3
parent 813 65144c52969c
child 815 468c9ec86928
Improve docs.
doc/groups.dox
src/hugo/time_measure.h
src/hugo/xy.h
     1.1 --- a/doc/groups.dox	Tue Sep 07 10:35:31 2004 +0000
     1.2 +++ b/doc/groups.dox	Tue Sep 07 10:56:37 2004 +0000
     1.3 @@ -1,3 +1,4 @@
     1.4 +
     1.5  /**
     1.6  @defgroup datas Data Structures
     1.7  This group describes the several graph structures implemented in HugoLib.
     1.8 @@ -16,7 +17,8 @@
     1.9  
    1.10  Hugolib also offers special graphs that cannot be used alone but only
    1.11  in conjunction with other graph representation. The examples for this are
    1.12 -\ref EdgeSet, \ref NodeSet, and the large variety of graph wrappers.
    1.13 +\ref hugo::EdgeSet "EdgeSet", \ref hugo::NodeSet "NodeSet"
    1.14 +and the large variety of \ref gwrappers "graph wrappers".
    1.15  
    1.16  You are free to use the graph structure that fit your requirements
    1.17  the best, most graph algorithms and auxiliary data structures can be used
    1.18 @@ -81,6 +83,3 @@
    1.19  This group contains some Experimental structures and algorithms.
    1.20  The stuff here is subject to change.
    1.21  */
    1.22 -
    1.23 -/// \ingroup misc experimental
    1.24 -namespace hugo { }
     2.1 --- a/src/hugo/time_measure.h	Tue Sep 07 10:35:31 2004 +0000
     2.2 +++ b/src/hugo/time_measure.h	Tue Sep 07 10:56:37 2004 +0000
     2.3 @@ -129,7 +129,7 @@
     2.4    ///\code
     2.5    ///#include<hugo/time_measure.h>
     2.6    ///#include<iostream>
     2.7 -
     2.8 +  ///
     2.9    ///int main()
    2.10    ///{
    2.11    ///
    2.12 @@ -193,6 +193,7 @@
    2.13    /// \li \c cu: user cpu time of children,
    2.14    /// \li \c cs: system cpu time of children,
    2.15    /// \li \c real: real time.
    2.16 +  /// \relates TimeStamp
    2.17    inline std::ostream& operator<<(std::ostream& os,const TimeStamp &t)
    2.18    {
    2.19      long cls = sysconf(_SC_CLK_TCK);
     3.1 --- a/src/hugo/xy.h	Tue Sep 07 10:35:31 2004 +0000
     3.2 +++ b/src/hugo/xy.h	Tue Sep 07 10:56:37 2004 +0000
     3.3 @@ -118,7 +118,10 @@
     3.4  
     3.5      };
     3.6  
     3.7 -  ///Reading a plainvector from a stream
     3.8 +  ///Read a plainvector from a stream
     3.9 +
    3.10 +  ///\relates xy
    3.11 +  ///
    3.12    template<typename T>
    3.13    inline
    3.14    std::istream& operator>>(std::istream &is, xy<T> &z)
    3.15 @@ -128,7 +131,10 @@
    3.16      return is;
    3.17    }
    3.18  
    3.19 -  ///Outputting a plainvector to a stream
    3.20 +  ///Write a plainvector to a stream
    3.21 +
    3.22 +  ///\relates xy
    3.23 +  ///
    3.24    template<typename T>
    3.25    inline
    3.26    std::ostream& operator<<(std::ostream &os, xy<T> z)