Doc improvement
authoralpar
Wed, 13 Jul 2005 19:49:36 +0000
changeset 155548769ac7ec32
parent 1554 572bc7d0d3e2
child 1556 caf0f91e16a7
Doc improvement
doc/Doxyfile.in
lemon/full_graph.h
lemon/graph_utils.h
lemon/kruskal.h
lemon/list_graph.h
lemon/maps.h
     1.1 --- a/doc/Doxyfile.in	Wed Jul 13 14:17:13 2005 +0000
     1.2 +++ b/doc/Doxyfile.in	Wed Jul 13 19:49:36 2005 +0000
     1.3 @@ -235,7 +235,7 @@
     1.4  # defined locally in source files will be included in the documentation. 
     1.5  # If set to NO only classes defined in header files are included.
     1.6  
     1.7 -EXTRACT_LOCAL_CLASSES  = YES
     1.8 +EXTRACT_LOCAL_CLASSES  = NO
     1.9  
    1.10  # This flag is only useful for Objective-C code. When set to YES local 
    1.11  # methods, which are defined in the implementation section but not in 
     2.1 --- a/lemon/full_graph.h	Wed Jul 13 14:17:13 2005 +0000
     2.2 +++ b/lemon/full_graph.h	Wed Jul 13 19:49:36 2005 +0000
     2.3 @@ -35,9 +35,6 @@
     2.4  
     2.5  namespace lemon {
     2.6  
     2.7 -/// \addtogroup graphs
     2.8 -/// @{
     2.9 -
    2.10    class FullGraphBase {
    2.11      int NodeNum;
    2.12      int EdgeNum;
    2.13 @@ -195,6 +192,9 @@
    2.14    typedef IterableGraphExtender<AlterableFullGraphBase> IterableFullGraphBase;
    2.15    typedef DefaultMappableGraphExtender<IterableFullGraphBase> MappableFullGraphBase;
    2.16  
    2.17 +  /// \addtogroup graphs
    2.18 +  /// @{
    2.19 +
    2.20    ///A full graph class.
    2.21  
    2.22    ///This is a simple and fast directed full graph implementation.
    2.23 @@ -211,6 +211,7 @@
    2.24      FullGraph(int n) { construct(n); }
    2.25    };
    2.26  
    2.27 +  ///@}
    2.28  
    2.29    // Base graph class for UndirFullGraph.
    2.30    class UndirFullGraphBase {
    2.31 @@ -373,9 +374,12 @@
    2.32  
    2.33    };
    2.34  
    2.35 +  /// \addtogroup graphs
    2.36 +  /// @{
    2.37 +
    2.38 +  
    2.39    /// \todo UndirFullGraph from the UndirFullGraphBase
    2.40  
    2.41 -  
    2.42  
    2.43    /// @}  
    2.44  
     3.1 --- a/lemon/graph_utils.h	Wed Jul 13 14:17:13 2005 +0000
     3.2 +++ b/lemon/graph_utils.h	Wed Jul 13 19:49:36 2005 +0000
     3.3 @@ -1092,7 +1092,7 @@
     3.4    /// in constant time. On the other hand, the values are updated automatically
     3.5    /// whenever the graph changes.
     3.6    ///
     3.7 -  /// \sa OutDegMap
     3.8 +  /// \sa InDegMap
     3.9  
    3.10    template <typename _Graph>
    3.11    class OutDegMap  
     4.1 --- a/lemon/kruskal.h	Wed Jul 13 14:17:13 2005 +0000
     4.2 +++ b/lemon/kruskal.h	Wed Jul 13 19:49:36 2005 +0000
     4.3 @@ -45,8 +45,11 @@
     4.4    /// Kruskal's algorithm to find a minimum cost tree of a graph.
     4.5  
     4.6    /// This function runs Kruskal's algorithm to find a minimum cost tree.
     4.7 -  /// \param g The graph the algorithm runs on. The algorithm considers the
     4.8 -  /// graph to be undirected, the direction of the edges are not used.
     4.9 +  /// \param g The graph the algorithm runs on.
    4.10 +  /// It can be either \ref concept::StaticGraph "directed" or 
    4.11 +  /// \ref concept::UndirStaticGraph "undirected".
    4.12 +  /// If the graph is directed, the algorithm consider it to be 
    4.13 +  /// undirected by disregarding the direction of the edges.
    4.14    ///
    4.15    /// \param in This object is used to describe the edge costs. It must
    4.16    /// be an STL compatible 'Forward Container'
     5.1 --- a/lemon/list_graph.h	Wed Jul 13 14:17:13 2005 +0000
     5.2 +++ b/lemon/list_graph.h	Wed Jul 13 19:49:36 2005 +0000
     5.3 @@ -539,6 +539,7 @@
     5.4      
     5.5    };
     5.6  
     5.7 +  ///@}
     5.8  
     5.9    /**************** Undirected List Graph ****************/
    5.10  
    5.11 @@ -550,6 +551,9 @@
    5.12      AlterableUndirGraphExtender<
    5.13      UndirGraphExtender<ListGraphBase> > > > > > > ErasableUndirListGraphBase;
    5.14  
    5.15 +/// \addtogroup graphs
    5.16 +/// @{
    5.17 +
    5.18    ///An undirected list graph class.
    5.19  
    5.20    ///This is a simple and fast erasable undirected graph implementation.
     6.1 --- a/lemon/maps.h	Wed Jul 13 14:17:13 2005 +0000
     6.2 +++ b/lemon/maps.h	Wed Jul 13 19:49:36 2005 +0000
     6.3 @@ -120,10 +120,10 @@
     6.4    }
     6.5  
     6.6  
     6.7 -  //to document later
     6.8 +  ///\todo to document later
     6.9    template<typename T, T v>
    6.10    struct Const { };
    6.11 -  //to document later
    6.12 +  ///\todo to document later
    6.13    template<typename K, typename V, V v>
    6.14    class ConstMap<K, Const<V, v> > : public MapBase<K, V>
    6.15    {