Changeset 682:1ea8162ce638 in lemon-0.x for src/work

Timestamp:

06/14/04 11:47:54 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

doc

Location:

src/work

Files:

• Doxyfile (modified) (3 diffs)
• jacint/max_matching.h (modified) (3 diffs)
• johanna/kruskal.h (modified) (1 diff)
• klao/path.h (modified) (1 diff)

src/work/Doxyfile

@@ -199 +199 @@
 # will be included in the documentation.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_STATIC tag is set to YES all static members of a file 
@@ -392 +392 @@
 # with spaces.
 
-INPUT                  = ../hugo \
+INPUT                  = ../../doc/mainpage.dox \
+                         ../../doc/graphs.dox \
+                         ../../doc/maps.dox ../../doc/coding_style.dox \
+                         ../../doc/groups.dox \
+                         ../hugo \
                          ../hugo/skeletons \
                          ../test/test_tools.h \
                          klao/path.h \
+                         klao/debug.h \
                          jacint/max_flow.h \
                          jacint/max_matching.h \ 
@@ -402 +407 @@
                          jacint/graph_gen.h \
                          marci/max_bipartite_matching.h \
-                         marci/bipartite_graph_wrapper.h
+                         marci/bipartite_graph_wrapper.h \
+                         deba/map_registry.h \
+                         deba/map_defines.h \
+                         deba/array_map_factory.h \
+                         johanna/kruskal.h \
+                         
 
 # If the value of the INPUT tag contains directories, you can use the 

src/work/jacint/max_matching.h

@@ -26 +26 @@
   ///\ref writeNMapNode, \ref writeNMapEdge or \ref writeEMapBool
   ///depending on the preferred container. 
-
+  ///
   ///The dual side of a mathcing is a map of the nodes to
   ///MaxMatching::pos_enum, having values D, A and C showing the
@@ -35 +35 @@
   ///writePos after running the algorithm. Before subsequent runs,
   ///the function \ref resetPos() must be called.
-
+  ///
   ///\param Graph The undirected graph type the algorithm runs on.
-
+  ///
   ///\author Jacint Szabo  
   template <typename Graph>
@@ -240 +240 @@
     ///After calling any run methods of the class, and before calling
     ///\ref resetPos(), it writes the Gallai-Edmonds canonical
-    ///decomposition of the graph. \c map must be a node map of \ref pos_enum 's.
+    ///decomposition of the graph. \c map must be a node map
+    ///of \ref pos_enum 's.
     template<typename NMapEnum>
     void writePos (NMapEnum& map) const {

src/work/johanna/kruskal.h

@@ -6 +6 @@
 #include <unionfind.h>
 #include <for_each_macros.h>
+
+///\file
+///\brief Kruskal's algorithm to compute a minimum cost tree
 
 namespace hugo {

src/work/klao/path.h

@@ -228 +228 @@
      * operation and until the commit()) the original Path is in a
      * "transitional" state (operations ot it have undefined result). But
-     * in the case of DirPath the original path is unchanged until the
+     * in the case of DirPath the original path remains unchanged until the
      * commit. However we don't recomend that you use this feature.
      */