Changeset 1555:48769ac7ec32 in lemon-0.x

Timestamp:

07/13/05 21:49:36 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2051

Message:

Doc improvement

Files:

• doc/Doxyfile.in (modified) (1 diff)
• lemon/full_graph.h (modified) (4 diffs)
• lemon/graph_utils.h (modified) (1 diff)
• lemon/kruskal.h (modified) (1 diff)
• lemon/list_graph.h (modified) (2 diffs)
• lemon/maps.h (modified) (1 diff)

doc/Doxyfile.in

@@ -236 +236 @@
 # 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 

lemon/full_graph.h

@@ -36 +36 @@
 namespace lemon {
 
-/// \addtogroup graphs
-/// @{
-
   class FullGraphBase {
     int NodeNum;
@@ -196 +193 @@
   typedef DefaultMappableGraphExtender<IterableFullGraphBase> MappableFullGraphBase;
 
+  /// \addtogroup graphs
+  /// @{
+
   ///A full graph class.
 
@@ -212 +212 @@
   };
 
+  ///@}
 
   // Base graph class for UndirFullGraph.
@@ -374 +375 @@
   };
 
+  /// \addtogroup graphs
+  /// @{
+
+  
   /// \todo UndirFullGraph from the UndirFullGraphBase
 
-  
 
   /// @}  

lemon/graph_utils.h

@@ -1093 +1093 @@
   /// whenever the graph changes.
   ///
-  /// \sa OutDegMap
+  /// \sa InDegMap
 
   template <typename _Graph>

lemon/kruskal.h

@@ -46 +46 @@
 
   /// 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

lemon/list_graph.h

@@ -540 +540 @@
   };
 
+  ///@}
 
   /**************** Undirected List Graph ****************/
@@ -550 +551 @@
     AlterableUndirGraphExtender<
     UndirGraphExtender<ListGraphBase> > > > > > > ErasableUndirListGraphBase;
+
+/// \addtogroup graphs
+/// @{
 
   ///An undirected list graph class.

lemon/maps.h

@@ -121 +121 @@
 
 
-  //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>