[Lemon-commits] [lemon_svn] alpar: r539 - in hugo/trunk: doc src/work/alpar src/work/marci

[Lemon SVN]

Author: alpar
Date: Mon Apr 26 11:00:12 2004
New Revision: 539

Added:
   hugo/trunk/doc/groups.dox
Modified:
   hugo/trunk/doc/Doxyfile
   hugo/trunk/src/work/alpar/list_graph.h
   hugo/trunk/src/work/marci/graph_wrapper.h

Log:
Docs are now divided into modules.


Modified: hugo/trunk/doc/Doxyfile
==============================================================================
--- hugo/trunk/doc/Doxyfile	(original)
+++ hugo/trunk/doc/Doxyfile	Mon Apr 26 11:00:12 2004
@@ -391,18 +391,20 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = ../src/include/skeletons/graph.h \
+INPUT                  = maps.dox groups.dox \
+                         ../src/include/skeletons/graph.h \
                          ../src/include/invalid.h \
                          ../src/include/smart_graph.h \
                          ../src/include/skeletons/maps.h \
                          ../src/include/dijkstra.h \
                          ../src/include/bin_heap.h \
                          ../src/include/fib_heap.h \
+                         ../src/work/alpar/list_graph.h \
                          ../src/work/athos/xy/xy.h \
                          ../src/work/athos/minlengthpaths.h \
 			 ../src/work/marci/time_measure.h \
-			 ../src/work/marci/graph_wrapper.h \	
-                         maps.dox
+			 ../src/work/marci/graph_wrapper.h
+                         
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 

Added: hugo/trunk/doc/groups.dox
==============================================================================
--- (empty file)
+++ hugo/trunk/doc/groups.dox	Mon Apr 26 11:00:12 2004
@@ -0,0 +1,15 @@
+
+/// @defgroup experimental Experimental strucures and algorithms
+/// This group contains some Experimental strucures and algorithms.
+/// The stuffs here are subject to change.
+
+/// \ingroup experimental
+namespace hugo { }
+
+/// @defgroup gwrappers Wrapper classes for graphs
+/// @ingroup experimental
+/// This group contains several wrapper classes for graphs
+
+/// @defgroup graphs Graph structures.
+/// @ingroup experimental
+/// This group describes the several graph structures implemented in HugoLib.
\ No newline at end of file

Modified: hugo/trunk/src/work/alpar/list_graph.h
==============================================================================
--- hugo/trunk/src/work/alpar/list_graph.h	(original)
+++ hugo/trunk/src/work/alpar/list_graph.h	Mon Apr 26 11:00:12 2004
@@ -3,6 +3,7 @@
 #ifndef HUGO_LIST_GRAPH_H
 #define HUGO_LIST_GRAPH_H
 
+///ingroup graphs
 ///\file
 ///\brief ListGraph, SymListGraph, NodeSet and EdgeSet classes.
 
@@ -13,6 +14,9 @@
 
 namespace hugo {
 
+/// \addtogroup graphs
+/// @{
+
   class SymListGraph;
 
   ///A list graph class.
@@ -1566,7 +1570,9 @@
     };
 
   };
-  
+
+/// @}  
+
 } //namespace hugo
 
 #endif //HUGO_LIST_GRAPH_H

Modified: hugo/trunk/src/work/marci/graph_wrapper.h
==============================================================================
--- hugo/trunk/src/work/marci/graph_wrapper.h	(original)
+++ hugo/trunk/src/work/marci/graph_wrapper.h	Mon Apr 26 11:00:12 2004
@@ -7,6 +7,9 @@
 
 namespace hugo {
 
+  /// \addtogroup gwrappers
+  /// @{
+
   /// Graph wrappers
 
   /// A main parts of HUGOlib are the different graph structures, 
@@ -1538,8 +1541,10 @@
     };
   };
 
+  ///@}
 
 } //namespace hugo
 
+
 #endif //HUGO_GRAPH_WRAPPER_H