Minor bug fixes in documentation
authordeba
Tue, 09 Oct 2007 16:22:04 +0000
changeset 249031a93dd6f714
parent 2489 48dddc283cfc
child 2491 b63ae56979ef
Minor bug fixes in documentation
lemon/bfs.h
lemon/dfs.h
lemon/fredman_tarjan.h
lemon/prim.h
     1.1 --- a/lemon/bfs.h	Tue Oct 09 15:46:12 2007 +0000
     1.2 +++ b/lemon/bfs.h	Tue Oct 09 16:22:04 2007 +0000
     1.3 @@ -151,14 +151,6 @@
     1.4      typedef TR Traits;
     1.5      ///The type of the underlying graph.
     1.6      typedef typename TR::Graph Graph;
     1.7 -    ///\e
     1.8 -    typedef typename Graph::Node Node;
     1.9 -    ///\e
    1.10 -    typedef typename Graph::NodeIt NodeIt;
    1.11 -    ///\e
    1.12 -    typedef typename Graph::Edge Edge;
    1.13 -    ///\e
    1.14 -    typedef typename Graph::OutEdgeIt OutEdgeIt;
    1.15      
    1.16      ///\brief The type of the map that stores the last
    1.17      ///edges of the shortest paths.
    1.18 @@ -170,6 +162,12 @@
    1.19      ///The type of the map that stores the dists of the nodes.
    1.20      typedef typename TR::DistMap DistMap;
    1.21    private:
    1.22 +
    1.23 +    typedef typename Graph::Node Node;
    1.24 +    typedef typename Graph::NodeIt NodeIt;
    1.25 +    typedef typename Graph::Edge Edge;
    1.26 +    typedef typename Graph::OutEdgeIt OutEdgeIt;
    1.27 +
    1.28      /// Pointer to the underlying graph.
    1.29      const Graph *G;
    1.30      ///Pointer to the map of predecessors edges.
    1.31 @@ -236,8 +234,9 @@
    1.32  	throw UninitializedParameter();
    1.33        }
    1.34      };
    1.35 -    ///\ref named-templ-param "Named parameter" for setting PredMap type
    1.36 -
    1.37 +    ///\brief \ref named-templ-param "Named parameter" for setting
    1.38 +    ///PredMap type
    1.39 +    ///
    1.40      ///\ref named-templ-param "Named parameter" for setting PredMap type
    1.41      ///
    1.42      template <class T>
    1.43 @@ -253,8 +252,9 @@
    1.44  	throw UninitializedParameter();
    1.45        }
    1.46      };
    1.47 -    ///\ref named-templ-param "Named parameter" for setting DistMap type
    1.48 -
    1.49 +    ///\brief \ref named-templ-param "Named parameter" for setting
    1.50 +    ///DistMap type
    1.51 +    ///
    1.52      ///\ref named-templ-param "Named parameter" for setting DistMap type
    1.53      ///
    1.54      template <class T>
    1.55 @@ -270,8 +270,9 @@
    1.56  	throw UninitializedParameter();
    1.57        }
    1.58      };
    1.59 -    ///\ref named-templ-param "Named parameter" for setting ReachedMap type
    1.60 -
    1.61 +    ///\brief \ref named-templ-param "Named parameter" for setting
    1.62 +    ///ReachedMap type
    1.63 +    ///
    1.64      ///\ref named-templ-param "Named parameter" for setting ReachedMap type
    1.65      ///
    1.66      template <class T>
    1.67 @@ -287,8 +288,9 @@
    1.68  	throw UninitializedParameter();
    1.69        }
    1.70      };
    1.71 -    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
    1.72 -
    1.73 +    ///\brief \ref named-templ-param "Named parameter" for setting
    1.74 +    ///ProcessedMap type
    1.75 +    ///
    1.76      ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
    1.77      ///
    1.78      template <class T>
    1.79 @@ -421,8 +423,8 @@
    1.80  
    1.81      ///@{
    1.82  
    1.83 -    ///Initializes the internal data structures.
    1.84 -
    1.85 +    ///\brief Initializes the internal data structures.
    1.86 +    ///
    1.87      ///Initializes the internal data structures.
    1.88      ///
    1.89      void init()
    1.90 @@ -1101,8 +1103,8 @@
    1.91  #ifdef DOXYGEN
    1.92    /// \brief Visitor class for bfs.
    1.93    ///  
    1.94 -  /// It gives a simple interface for a functional interface for bfs 
    1.95 -  /// traversal. The traversal on a linear data structure. 
    1.96 +  /// This class defines the interface of the BfsVisit events, and
    1.97 +  /// it could be the base of a real Visitor class.
    1.98    template <typename _Graph>
    1.99    struct BfsVisitor {
   1.100      typedef _Graph Graph;
   1.101 @@ -1187,10 +1189,11 @@
   1.102      }
   1.103  
   1.104    };
   1.105 -  
   1.106 -  /// %BFS Visit algorithm class.
   1.107 -  
   1.108 +
   1.109    /// \ingroup search
   1.110 +  ///  
   1.111 +  /// \brief %BFS Visit algorithm class.
   1.112 +  ///  
   1.113    /// This class provides an efficient implementation of the %BFS algorithm
   1.114    /// with visitor interface.
   1.115    ///
     2.1 --- a/lemon/dfs.h	Tue Oct 09 15:46:12 2007 +0000
     2.2 +++ b/lemon/dfs.h	Tue Oct 09 16:22:04 2007 +0000
     2.3 @@ -236,8 +236,9 @@
     2.4  	throw UninitializedParameter();
     2.5        }
     2.6      };
     2.7 -    ///\ref named-templ-param "Named parameter" for setting PredMap type
     2.8 -
     2.9 +    ///\brief \ref named-templ-param "Named parameter" for setting
    2.10 +    ///PredMap type
    2.11 +    ///
    2.12      ///\ref named-templ-param "Named parameter" for setting PredMap type
    2.13      ///
    2.14      template <class T>
    2.15 @@ -254,10 +255,11 @@
    2.16  	throw UninitializedParameter();
    2.17        }
    2.18      };
    2.19 -    ///\ref named-templ-param "Named parameter" for setting DistMap type
    2.20 -
    2.21 -    ///\ref named-templ-param "Named parameter" for setting DistMap type
    2.22 +    ///\brief \ref named-templ-param "Named parameter" for setting
    2.23 +    ///DistMap type
    2.24      ///
    2.25 +    ///\ref named-templ-param "Named parameter" for setting DistMap
    2.26 +    ///type
    2.27      template <class T>
    2.28      struct DefDistMap {
    2.29        typedef Dfs<Graph, DefDistMapTraits<T> > Create;
    2.30 @@ -271,8 +273,9 @@
    2.31  	throw UninitializedParameter();
    2.32        }
    2.33      };
    2.34 -    ///\ref named-templ-param "Named parameter" for setting ReachedMap type
    2.35 -
    2.36 +    ///\brief \ref named-templ-param "Named parameter" for setting
    2.37 +    ///ReachedMap type
    2.38 +    ///
    2.39      ///\ref named-templ-param "Named parameter" for setting ReachedMap type
    2.40      ///
    2.41      template <class T>
    2.42 @@ -288,8 +291,9 @@
    2.43  	throw UninitializedParameter();
    2.44        }
    2.45      };
    2.46 -    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
    2.47 -
    2.48 +    ///\brief \ref named-templ-param "Named parameter" for setting
    2.49 +    ///ProcessedMap type
    2.50 +    ///
    2.51      ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
    2.52      ///
    2.53      template <class T>
     3.1 --- a/lemon/fredman_tarjan.h	Tue Oct 09 15:46:12 2007 +0000
     3.2 +++ b/lemon/fredman_tarjan.h	Tue Oct 09 16:22:04 2007 +0000
     3.3 @@ -192,8 +192,8 @@
     3.4  	throw UninitializedParameter();
     3.5        }
     3.6      };
     3.7 -    ///\ref named-templ-param "Named parameter" for setting TreeMap 
     3.8 -
     3.9 +    ///\brief \ref named-templ-param "Named parameter" for setting TreeMap 
    3.10 +    ///
    3.11      ///\ref named-templ-param "Named parameter" for setting TreeMap
    3.12      ///
    3.13      template <class TM>
     4.1 --- a/lemon/prim.h	Tue Oct 09 15:46:12 2007 +0000
     4.2 +++ b/lemon/prim.h	Tue Oct 09 16:22:04 2007 +0000
     4.3 @@ -284,8 +284,8 @@
     4.4  	throw UninitializedParameter();
     4.5        }
     4.6      };
     4.7 -    ///\ref named-templ-param "Named parameter" for setting PredMap type
     4.8 -
     4.9 +    ///\brief \ref named-templ-param "Named parameter" for setting PredMap type
    4.10 +    ///
    4.11      ///\ref named-templ-param "Named parameter" for setting PredMap type
    4.12      ///
    4.13      template <class T>
    4.14 @@ -301,8 +301,9 @@
    4.15  	throw UninitializedParameter();
    4.16        }
    4.17      };
    4.18 -    ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
    4.19 -
    4.20 +    ///\brief \ref named-templ-param "Named parameter" for setting
    4.21 +    ///ProcessedMap type
    4.22 +    ///
    4.23      ///\ref named-templ-param "Named parameter" for setting ProcessedMap type
    4.24      ///
    4.25      template <class T>
    4.26 @@ -374,8 +375,9 @@
    4.27          throw UninitializedParameter();
    4.28        }
    4.29      };
    4.30 -    ///\ref named-templ-param "Named parameter" for setting TreeMap
    4.31 -
    4.32 +    ///\brief \ref named-templ-param "Named parameter" for setting
    4.33 +    ///TreeMap
    4.34 +    ///
    4.35      ///\ref named-templ-param "Named parameter" for setting TreeMap
    4.36      ///
    4.37      template <class TM>