diff -r 907446600ca9 -r 9db8964f0cf6 lemon/dfs.h --- a/lemon/dfs.h Tue Oct 07 07:08:45 2008 +0100 +++ b/lemon/dfs.h Wed Oct 08 13:40:20 2008 +0200 @@ -50,11 +50,11 @@ ///arcs of the %DFS paths. ///It must meet the \ref concepts::WriteMap "WriteMap" concept. typedef typename Digraph::template NodeMap PredMap; - ///Instantiates a \ref PredMap. + ///Instantiates a PredMap. - ///This function instantiates a \ref PredMap. + ///This function instantiates a PredMap. ///\param g is the digraph, to which we would like to define the - ///\ref PredMap. + ///PredMap. static PredMap *createPredMap(const Digraph &g) { return new PredMap(g); @@ -65,11 +65,11 @@ ///The type of the map that indicates which nodes are processed. ///It must meet the \ref concepts::WriteMap "WriteMap" concept. typedef NullMap ProcessedMap; - ///Instantiates a \ref ProcessedMap. + ///Instantiates a ProcessedMap. - ///This function instantiates a \ref ProcessedMap. + ///This function instantiates a ProcessedMap. ///\param g is the digraph, to which - ///we would like to define the \ref ProcessedMap + ///we would like to define the ProcessedMap #ifdef DOXYGEN static ProcessedMap *createProcessedMap(const Digraph &g) #else @@ -84,11 +84,11 @@ ///The type of the map that indicates which nodes are reached. ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept. typedef typename Digraph::template NodeMap ReachedMap; - ///Instantiates a \ref ReachedMap. + ///Instantiates a ReachedMap. - ///This function instantiates a \ref ReachedMap. + ///This function instantiates a ReachedMap. ///\param g is the digraph, to which - ///we would like to define the \ref ReachedMap. + ///we would like to define the ReachedMap. static ReachedMap *createReachedMap(const Digraph &g) { return new ReachedMap(g); @@ -99,11 +99,11 @@ ///The type of the map that stores the distances of the nodes. ///It must meet the \ref concepts::WriteMap "WriteMap" concept. typedef typename Digraph::template NodeMap DistMap; - ///Instantiates a \ref DistMap. + ///Instantiates a DistMap. - ///This function instantiates a \ref DistMap. + ///This function instantiates a DistMap. ///\param g is the digraph, to which we would like to define the - ///\ref DistMap. + ///DistMap. static DistMap *createDistMap(const Digraph &g) { return new DistMap(g); @@ -227,10 +227,10 @@ } }; ///\brief \ref named-templ-param "Named parameter" for setting - ///\ref PredMap type. + ///PredMap type. /// ///\ref named-templ-param "Named parameter" for setting - ///\ref PredMap type. + ///PredMap type. template struct SetPredMap : public Dfs > { typedef Dfs > Create; @@ -246,10 +246,10 @@ } }; ///\brief \ref named-templ-param "Named parameter" for setting - ///\ref DistMap type. + ///DistMap type. /// ///\ref named-templ-param "Named parameter" for setting - ///\ref DistMap type. + ///DistMap type. template struct SetDistMap : public Dfs< Digraph, SetDistMapTraits > { typedef Dfs > Create; @@ -265,10 +265,10 @@ } }; ///\brief \ref named-templ-param "Named parameter" for setting - ///\ref ReachedMap type. + ///ReachedMap type. /// ///\ref named-templ-param "Named parameter" for setting - ///\ref ReachedMap type. + ///ReachedMap type. template struct SetReachedMap : public Dfs< Digraph, SetReachedMapTraits > { typedef Dfs< Digraph, SetReachedMapTraits > Create; @@ -284,10 +284,10 @@ } }; ///\brief \ref named-templ-param "Named parameter" for setting - ///\ref ProcessedMap type. + ///ProcessedMap type. /// ///\ref named-templ-param "Named parameter" for setting - ///\ref ProcessedMap type. + ///ProcessedMap type. template struct SetProcessedMap : public Dfs< Digraph, SetProcessedMapTraits > { typedef Dfs< Digraph, SetProcessedMapTraits > Create; @@ -301,10 +301,10 @@ } }; ///\brief \ref named-templ-param "Named parameter" for setting - ///\ref ProcessedMap type to be Digraph::NodeMap. + ///ProcessedMap type to be Digraph::NodeMap. /// ///\ref named-templ-param "Named parameter" for setting - ///\ref ProcessedMap type to be Digraph::NodeMap. + ///ProcessedMap type to be Digraph::NodeMap. ///If you don't set it explicitly, it will be automatically allocated. struct SetStandardProcessedMap : public Dfs< Digraph, SetStandardProcessedMapTraits > { @@ -768,11 +768,11 @@ ///arcs of the %DFS paths. ///It must meet the \ref concepts::WriteMap "WriteMap" concept. typedef typename Digraph::template NodeMap PredMap; - ///Instantiates a \ref PredMap. + ///Instantiates a PredMap. - ///This function instantiates a \ref PredMap. + ///This function instantiates a PredMap. ///\param g is the digraph, to which we would like to define the - ///\ref PredMap. + ///PredMap. static PredMap *createPredMap(const Digraph &g) { return new PredMap(g); @@ -784,11 +784,11 @@ ///It must meet the \ref concepts::WriteMap "WriteMap" concept. ///By default it is a NullMap. typedef NullMap ProcessedMap; - ///Instantiates a \ref ProcessedMap. + ///Instantiates a ProcessedMap. - ///This function instantiates a \ref ProcessedMap. + ///This function instantiates a ProcessedMap. ///\param g is the digraph, to which - ///we would like to define the \ref ProcessedMap. + ///we would like to define the ProcessedMap. #ifdef DOXYGEN static ProcessedMap *createProcessedMap(const Digraph &g) #else @@ -803,11 +803,11 @@ ///The type of the map that indicates which nodes are reached. ///It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept. typedef typename Digraph::template NodeMap ReachedMap; - ///Instantiates a \ref ReachedMap. + ///Instantiates a ReachedMap. - ///This function instantiates a \ref ReachedMap. + ///This function instantiates a ReachedMap. ///\param g is the digraph, to which - ///we would like to define the \ref ReachedMap. + ///we would like to define the ReachedMap. static ReachedMap *createReachedMap(const Digraph &g) { return new ReachedMap(g); @@ -818,11 +818,11 @@ ///The type of the map that stores the distances of the nodes. ///It must meet the \ref concepts::WriteMap "WriteMap" concept. typedef typename Digraph::template NodeMap DistMap; - ///Instantiates a \ref DistMap. + ///Instantiates a DistMap. - ///This function instantiates a \ref DistMap. + ///This function instantiates a DistMap. ///\param g is the digraph, to which we would like to define - ///the \ref DistMap + ///the DistMap static DistMap *createDistMap(const Digraph &g) { return new DistMap(g); @@ -1001,10 +1001,10 @@ SetPredMapBase(const TR &b) : TR(b) {} }; ///\brief \ref named-func-param "Named parameter" - ///for setting \ref PredMap object. + ///for setting PredMap object. /// ///\ref named-func-param "Named parameter" - ///for setting \ref PredMap object. + ///for setting PredMap object. template DfsWizard > predMap(const T &t) { @@ -1019,10 +1019,10 @@ SetReachedMapBase(const TR &b) : TR(b) {} }; ///\brief \ref named-func-param "Named parameter" - ///for setting \ref ReachedMap object. + ///for setting ReachedMap object. /// /// \ref named-func-param "Named parameter" - ///for setting \ref ReachedMap object. + ///for setting ReachedMap object. template DfsWizard > reachedMap(const T &t) { @@ -1037,10 +1037,10 @@ SetDistMapBase(const TR &b) : TR(b) {} }; ///\brief \ref named-func-param "Named parameter" - ///for setting \ref DistMap object. + ///for setting DistMap object. /// /// \ref named-func-param "Named parameter" - ///for setting \ref DistMap object. + ///for setting DistMap object. template DfsWizard > distMap(const T &t) { @@ -1055,10 +1055,10 @@ SetProcessedMapBase(const TR &b) : TR(b) {} }; ///\brief \ref named-func-param "Named parameter" - ///for setting \ref ProcessedMap object. + ///for setting ProcessedMap object. /// /// \ref named-func-param "Named parameter" - ///for setting \ref ProcessedMap object. + ///for setting ProcessedMap object. template DfsWizard > processedMap(const T &t) { @@ -1213,11 +1213,11 @@ /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept. typedef typename Digraph::template NodeMap ReachedMap; - /// \brief Instantiates a \ref ReachedMap. + /// \brief Instantiates a ReachedMap. /// - /// This function instantiates a \ref ReachedMap. + /// This function instantiates a ReachedMap. /// \param digraph is the digraph, to which - /// we would like to define the \ref ReachedMap. + /// we would like to define the ReachedMap. static ReachedMap *createReachedMap(const Digraph &digraph) { return new ReachedMap(digraph); }