[Lemon-commits] [lemon_svn] alpar: r1110 - in hugo/trunk: doc src/hugo

[Lemon SVN]

Author: alpar
Date: Tue Sep  7 12:56:37 2004
New Revision: 1110

Modified:
   hugo/trunk/doc/groups.dox
   hugo/trunk/src/hugo/time_measure.h
   hugo/trunk/src/hugo/xy.h

Log:
Improve docs.


Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Tue Sep  7 12:56:37 2004
@@ -1,3 +1,4 @@
+
 /**
 @defgroup datas Data Structures
 This group describes the several graph structures implemented in HugoLib.
@@ -16,7 +17,8 @@
 
 Hugolib also offers special graphs that cannot be used alone but only
 in conjunction with other graph representation. The examples for this are
-\ref EdgeSet, \ref NodeSet, and the large variety of graph wrappers.
+\ref hugo::EdgeSet "EdgeSet", \ref hugo::NodeSet "NodeSet"
+and the large variety of \ref gwrappers "graph wrappers".
 
 You are free to use the graph structure that fit your requirements
 the best, most graph algorithms and auxiliary data structures can be used
@@ -81,6 +83,3 @@
 This group contains some Experimental structures and algorithms.
 The stuff here is subject to change.
 */
-
-/// \ingroup misc experimental
-namespace hugo { }

Modified: hugo/trunk/src/hugo/time_measure.h
==============================================================================
--- hugo/trunk/src/hugo/time_measure.h	(original)
+++ hugo/trunk/src/hugo/time_measure.h	Tue Sep  7 12:56:37 2004
@@ -129,7 +129,7 @@
   ///\code
   ///#include<hugo/time_measure.h>
   ///#include<iostream>
-
+  ///
   ///int main()
   ///{
   ///
@@ -193,6 +193,7 @@
   /// \li \c cu: user cpu time of children,
   /// \li \c cs: system cpu time of children,
   /// \li \c real: real time.
+  /// \relates TimeStamp
   inline std::ostream& operator<<(std::ostream& os,const TimeStamp &t)
   {
     long cls = sysconf(_SC_CLK_TCK);

Modified: hugo/trunk/src/hugo/xy.h
==============================================================================
--- hugo/trunk/src/hugo/xy.h	(original)
+++ hugo/trunk/src/hugo/xy.h	Tue Sep  7 12:56:37 2004
@@ -118,7 +118,10 @@
 
     };
 
-  ///Reading a plainvector from a stream
+  ///Read a plainvector from a stream
+
+  ///\relates xy
+  ///
   template<typename T>
   inline
   std::istream& operator>>(std::istream &is, xy<T> &z)
@@ -128,7 +131,10 @@
     return is;
   }
 
-  ///Outputting a plainvector to a stream
+  ///Write a plainvector to a stream
+
+  ///\relates xy
+  ///
   template<typename T>
   inline
   std::ostream& operator<<(std::ostream &os, xy<T> z)