[Lemon-commits] [lemon_svn] alpar: r2051 - in hugo/trunk: doc lemon

[Lemon SVN]

Author: alpar
Date: Wed Jul 13 21:49:36 2005
New Revision: 2051

Modified:
   hugo/trunk/doc/Doxyfile.in
   hugo/trunk/lemon/full_graph.h
   hugo/trunk/lemon/graph_utils.h
   hugo/trunk/lemon/kruskal.h
   hugo/trunk/lemon/list_graph.h
   hugo/trunk/lemon/maps.h

Log:
Doc improvement

Modified: hugo/trunk/doc/Doxyfile.in
==============================================================================
--- hugo/trunk/doc/Doxyfile.in	(original)
+++ hugo/trunk/doc/Doxyfile.in	Wed Jul 13 21:49:36 2005
@@ -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 

Modified: hugo/trunk/lemon/full_graph.h
==============================================================================
--- hugo/trunk/lemon/full_graph.h	(original)
+++ hugo/trunk/lemon/full_graph.h	Wed Jul 13 21:49:36 2005
@@ -35,9 +35,6 @@
 
 namespace lemon {
 
-/// \addtogroup graphs
-/// @{
-
   class FullGraphBase {
     int NodeNum;
     int EdgeNum;
@@ -195,6 +192,9 @@
   typedef IterableGraphExtender<AlterableFullGraphBase> IterableFullGraphBase;
   typedef DefaultMappableGraphExtender<IterableFullGraphBase> 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 @@
 
   };
 
-  /// \todo UndirFullGraph from the UndirFullGraphBase
+  /// \addtogroup graphs
+  /// @{
 
   
+  /// \todo UndirFullGraph from the UndirFullGraphBase
+
 
   /// @}  
 

Modified: hugo/trunk/lemon/graph_utils.h
==============================================================================
--- hugo/trunk/lemon/graph_utils.h	(original)
+++ hugo/trunk/lemon/graph_utils.h	Wed Jul 13 21:49:36 2005
@@ -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 <typename _Graph>
   class OutDegMap  

Modified: hugo/trunk/lemon/kruskal.h
==============================================================================
--- hugo/trunk/lemon/kruskal.h	(original)
+++ hugo/trunk/lemon/kruskal.h	Wed Jul 13 21:49:36 2005
@@ -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'

Modified: hugo/trunk/lemon/list_graph.h
==============================================================================
--- hugo/trunk/lemon/list_graph.h	(original)
+++ hugo/trunk/lemon/list_graph.h	Wed Jul 13 21:49:36 2005
@@ -539,6 +539,7 @@
     
   };
 
+  ///@}
 
   /**************** Undirected List Graph ****************/
 
@@ -550,6 +551,9 @@
     AlterableUndirGraphExtender<
     UndirGraphExtender<ListGraphBase> > > > > > > ErasableUndirListGraphBase;
 
+/// \addtogroup graphs
+/// @{
+
   ///An undirected list graph class.
 
   ///This is a simple and fast erasable undirected graph implementation.

Modified: hugo/trunk/lemon/maps.h
==============================================================================
--- hugo/trunk/lemon/maps.h	(original)
+++ hugo/trunk/lemon/maps.h	Wed Jul 13 21:49:36 2005
@@ -120,10 +120,10 @@
   }
 
 
-  //to document later
+  ///\todo to document later
   template<typename T, T v>
   struct Const { };
-  //to document later
+  ///\todo to document later
   template<typename K, typename V, V v>
   class ConstMap<K, Const<V, v> > : public MapBase<K, V>
   {