Docs are now divided into modules.
authoralpar
Mon, 26 Apr 2004 09:00:12 +0000
changeset 406e8377ac921b6
parent 405 a2d8ec38e8db
child 407 e34e1bc610cf
Docs are now divided into modules.
doc/Doxyfile
doc/groups.dox
src/work/alpar/list_graph.h
src/work/marci/graph_wrapper.h
     1.1 --- a/doc/Doxyfile	Mon Apr 26 08:07:53 2004 +0000
     1.2 +++ b/doc/Doxyfile	Mon Apr 26 09:00:12 2004 +0000
     1.3 @@ -391,18 +391,20 @@
     1.4  # directories like "/usr/src/myproject". Separate the files or directories 
     1.5  # with spaces.
     1.6  
     1.7 -INPUT                  = ../src/include/skeletons/graph.h \
     1.8 +INPUT                  = maps.dox groups.dox \
     1.9 +                         ../src/include/skeletons/graph.h \
    1.10                           ../src/include/invalid.h \
    1.11                           ../src/include/smart_graph.h \
    1.12                           ../src/include/skeletons/maps.h \
    1.13                           ../src/include/dijkstra.h \
    1.14                           ../src/include/bin_heap.h \
    1.15                           ../src/include/fib_heap.h \
    1.16 +                         ../src/work/alpar/list_graph.h \
    1.17                           ../src/work/athos/xy/xy.h \
    1.18                           ../src/work/athos/minlengthpaths.h \
    1.19  			 ../src/work/marci/time_measure.h \
    1.20 -			 ../src/work/marci/graph_wrapper.h \	
    1.21 -                         maps.dox
    1.22 +			 ../src/work/marci/graph_wrapper.h
    1.23 +                         
    1.24  
    1.25  # If the value of the INPUT tag contains directories, you can use the 
    1.26  # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/doc/groups.dox	Mon Apr 26 09:00:12 2004 +0000
     2.3 @@ -0,0 +1,15 @@
     2.4 +
     2.5 +/// @defgroup experimental Experimental strucures and algorithms
     2.6 +/// This group contains some Experimental strucures and algorithms.
     2.7 +/// The stuffs here are subject to change.
     2.8 +
     2.9 +/// \ingroup experimental
    2.10 +namespace hugo { }
    2.11 +
    2.12 +/// @defgroup gwrappers Wrapper classes for graphs
    2.13 +/// @ingroup experimental
    2.14 +/// This group contains several wrapper classes for graphs
    2.15 +
    2.16 +/// @defgroup graphs Graph structures.
    2.17 +/// @ingroup experimental
    2.18 +/// This group describes the several graph structures implemented in HugoLib.
    2.19 \ No newline at end of file
     3.1 --- a/src/work/alpar/list_graph.h	Mon Apr 26 08:07:53 2004 +0000
     3.2 +++ b/src/work/alpar/list_graph.h	Mon Apr 26 09:00:12 2004 +0000
     3.3 @@ -3,6 +3,7 @@
     3.4  #ifndef HUGO_LIST_GRAPH_H
     3.5  #define HUGO_LIST_GRAPH_H
     3.6  
     3.7 +///ingroup graphs
     3.8  ///\file
     3.9  ///\brief ListGraph, SymListGraph, NodeSet and EdgeSet classes.
    3.10  
    3.11 @@ -13,6 +14,9 @@
    3.12  
    3.13  namespace hugo {
    3.14  
    3.15 +/// \addtogroup graphs
    3.16 +/// @{
    3.17 +
    3.18    class SymListGraph;
    3.19  
    3.20    ///A list graph class.
    3.21 @@ -1566,7 +1570,9 @@
    3.22      };
    3.23  
    3.24    };
    3.25 -  
    3.26 +
    3.27 +/// @}  
    3.28 +
    3.29  } //namespace hugo
    3.30  
    3.31  #endif //HUGO_LIST_GRAPH_H
     4.1 --- a/src/work/marci/graph_wrapper.h	Mon Apr 26 08:07:53 2004 +0000
     4.2 +++ b/src/work/marci/graph_wrapper.h	Mon Apr 26 09:00:12 2004 +0000
     4.3 @@ -7,6 +7,9 @@
     4.4  
     4.5  namespace hugo {
     4.6  
     4.7 +  /// \addtogroup gwrappers
     4.8 +  /// @{
     4.9 +
    4.10    /// Graph wrappers
    4.11  
    4.12    /// A main parts of HUGOlib are the different graph structures, 
    4.13 @@ -1538,8 +1541,10 @@
    4.14      };
    4.15    };
    4.16  
    4.17 +  ///@}
    4.18  
    4.19  } //namespace hugo
    4.20  
    4.21 +
    4.22  #endif //HUGO_GRAPH_WRAPPER_H
    4.23