# HG changeset patch # User alpar # Date 1121284176 0 # Node ID 48769ac7ec32208fe3024377cce6dc253527e233 # Parent 572bc7d0d3e27234336914c42446d552da2e6bb9 Doc improvement diff -r 572bc7d0d3e2 -r 48769ac7ec32 doc/Doxyfile.in --- a/doc/Doxyfile.in Wed Jul 13 14:17:13 2005 +0000 +++ b/doc/Doxyfile.in Wed Jul 13 19:49:36 2005 +0000 @@ -235,7 +235,7 @@ # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. -EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in diff -r 572bc7d0d3e2 -r 48769ac7ec32 lemon/full_graph.h --- a/lemon/full_graph.h Wed Jul 13 14:17:13 2005 +0000 +++ b/lemon/full_graph.h Wed Jul 13 19:49:36 2005 +0000 @@ -35,9 +35,6 @@ namespace lemon { -/// \addtogroup graphs -/// @{ - class FullGraphBase { int NodeNum; int EdgeNum; @@ -195,6 +192,9 @@ typedef IterableGraphExtender IterableFullGraphBase; typedef DefaultMappableGraphExtender MappableFullGraphBase; + /// \addtogroup graphs + /// @{ + ///A full graph class. ///This is a simple and fast directed full graph implementation. @@ -211,6 +211,7 @@ FullGraph(int n) { construct(n); } }; + ///@} // Base graph class for UndirFullGraph. class UndirFullGraphBase { @@ -373,9 +374,12 @@ }; + /// \addtogroup graphs + /// @{ + + /// \todo UndirFullGraph from the UndirFullGraphBase - /// @} diff -r 572bc7d0d3e2 -r 48769ac7ec32 lemon/graph_utils.h --- a/lemon/graph_utils.h Wed Jul 13 14:17:13 2005 +0000 +++ b/lemon/graph_utils.h Wed Jul 13 19:49:36 2005 +0000 @@ -1092,7 +1092,7 @@ /// in constant time. On the other hand, the values are updated automatically /// whenever the graph changes. /// - /// \sa OutDegMap + /// \sa InDegMap template class OutDegMap diff -r 572bc7d0d3e2 -r 48769ac7ec32 lemon/kruskal.h --- a/lemon/kruskal.h Wed Jul 13 14:17:13 2005 +0000 +++ b/lemon/kruskal.h Wed Jul 13 19:49:36 2005 +0000 @@ -45,8 +45,11 @@ /// Kruskal's algorithm to find a minimum cost tree of a graph. /// This function runs Kruskal's algorithm to find a minimum cost tree. - /// \param g The graph the algorithm runs on. The algorithm considers the - /// graph to be undirected, the direction of the edges are not used. + /// \param g The graph the algorithm runs on. + /// It can be either \ref concept::StaticGraph "directed" or + /// \ref concept::UndirStaticGraph "undirected". + /// If the graph is directed, the algorithm consider it to be + /// undirected by disregarding the direction of the edges. /// /// \param in This object is used to describe the edge costs. It must /// be an STL compatible 'Forward Container' diff -r 572bc7d0d3e2 -r 48769ac7ec32 lemon/list_graph.h --- a/lemon/list_graph.h Wed Jul 13 14:17:13 2005 +0000 +++ b/lemon/list_graph.h Wed Jul 13 19:49:36 2005 +0000 @@ -539,6 +539,7 @@ }; + ///@} /**************** Undirected List Graph ****************/ @@ -550,6 +551,9 @@ AlterableUndirGraphExtender< UndirGraphExtender > > > > > > ErasableUndirListGraphBase; +/// \addtogroup graphs +/// @{ + ///An undirected list graph class. ///This is a simple and fast erasable undirected graph implementation. diff -r 572bc7d0d3e2 -r 48769ac7ec32 lemon/maps.h --- a/lemon/maps.h Wed Jul 13 14:17:13 2005 +0000 +++ b/lemon/maps.h Wed Jul 13 19:49:36 2005 +0000 @@ -120,10 +120,10 @@ } - //to document later + ///\todo to document later template struct Const { }; - //to document later + ///\todo to document later template class ConstMap > : public MapBase {