LEMON/LEMON-official Changeset - r301:9db8964f0cf6

Repositories » LEMON » LEMON-official

Summary
Changelog
Files
Switch To
- loading...
Options
- Lightweight changelog
- Search
Pull Requests

Changeset - r301:9db8964f0cf6

« 299:907446

302:187177 »

r301:9db8964f0cf6

Wed, 08 Oct 2008 13:40:20

[Not Reviewed]

0 comments (0 inline)

kpeter (Peter Kovacs)
kpeter@inf.elte.hu

Fix several doxygen warings

0 4 0

default

4 files changed with 238 insertions and 238 deletions:

lemon/bfs.h

lemon/dfs.h

lemon/dijkstra.h

lemon/maps.h

115

↑ Collapse diff ↑

lemon/bfs.h

Show inline comments

@@ -49,11 +49,11 @@
 		    ///arcs of the shortest paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> 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);
@@ -64,11 +64,11 @@
 		    ///The type of the map that indicates which nodes are processed.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    typedef NullMap<typename Digraph::Node,bool> 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
@@ -83,11 +83,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<bool> 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);
@@ -98,11 +98,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<int> 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 <class T>
 		    struct SetPredMap : public Bfs< Digraph, SetPredMapTraits<T> > {
 		      typedef Bfs< Digraph, SetPredMapTraits<T> > 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 <class T>
 		    struct SetDistMap : public Bfs< Digraph, SetDistMapTraits<T> > {
 		      typedef Bfs< Digraph, SetDistMapTraits<T> > 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 <class T>
 		    struct SetReachedMap : public Bfs< Digraph, SetReachedMapTraits<T> > {
 		      typedef Bfs< Digraph, SetReachedMapTraits<T> > 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 <class T>
 		    struct SetProcessedMap : public Bfs< Digraph, SetProcessedMapTraits<T> > {
 		      typedef Bfs< Digraph, SetProcessedMapTraits<T> > Create;
@@ -302,10 +302,10 @@
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter" for setting
-		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
-		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///If you don't set it explicitly, it will be automatically allocated.
 		    struct SetStandardProcessedMap :
 		      public Bfs< Digraph, SetStandardProcessedMapTraits > {
@@ -835,11 +835,11 @@
 		    ///arcs of the shortest paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> 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);
@@ -851,11 +851,11 @@
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///By default it is a NullMap.
 		    typedef NullMap<typename Digraph::Node,bool> 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
@@ -870,11 +870,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<bool> 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);
@@ -885,11 +885,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<int> 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);
@@ -902,7 +902,7 @@
 		    typedef lemon::Path<Digraph> Path;
 		  };
-		  /// Default traits class used by \ref BfsWizard
 		  /// Default traits class used by BfsWizard
 		  /// To make it easier to use Bfs algorithm
 		  /// we have created a wizard class.
@@ -1068,10 +1068,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<class T>
 		    BfsWizard<SetPredMapBase<T> > predMap(const T &t)
+		    {
@@ -1086,10 +1086,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<class T>
 		    BfsWizard<SetReachedMapBase<T> > reachedMap(const T &t)
+		    {
@@ -1104,10 +1104,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<class T>
 		    BfsWizard<SetDistMapBase<T> > distMap(const T &t)
+		    {
@@ -1122,10 +1122,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<class T>
 		    BfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
+		    {
@@ -1267,11 +1267,11 @@
 		    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 		    typedef typename Digraph::template NodeMap<bool> 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);
+		    }

lemon/dfs.h

Show inline comments

@@ -50,11 +50,11 @@
 		    ///arcs of the %DFS paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> 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<typename Digraph::Node,bool> 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<bool> 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<int> 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 <class T>
 		    struct SetPredMap : public Dfs<Digraph, SetPredMapTraits<T> > {
 		      typedef Dfs<Digraph, SetPredMapTraits<T> > 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 <class T>
 		    struct SetDistMap : public Dfs< Digraph, SetDistMapTraits<T> > {
 		      typedef Dfs<Digraph, SetDistMapTraits<T> > 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 <class T>
 		    struct SetReachedMap : public Dfs< Digraph, SetReachedMapTraits<T> > {
 		      typedef Dfs< Digraph, SetReachedMapTraits<T> > 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 <class T>
 		    struct SetProcessedMap : public Dfs< Digraph, SetProcessedMapTraits<T> > {
 		      typedef Dfs< Digraph, SetProcessedMapTraits<T> > Create;
@@ -301,10 +301,10 @@
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter" for setting
-		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
-		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///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<typename Digraph::Arc> 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<typename Digraph::Node,bool> 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<bool> 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<int> 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<class T>
 		    DfsWizard<SetPredMapBase<T> > 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<class T>
 		    DfsWizard<SetReachedMapBase<T> > 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<class T>
 		    DfsWizard<SetDistMapBase<T> > 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<class T>
 		    DfsWizard<SetProcessedMapBase<T> > processedMap(const T &t)
+		    {
@@ -1213,11 +1213,11 @@
 		    /// It must meet the \ref concepts::ReadWriteMap "ReadWriteMap" concept.
 		    typedef typename Digraph::template NodeMap<bool> 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);
+		    }

lemon/dijkstra.h

Show inline comments

@@ -139,11 +139,11 @@
 		    ///arcs of the shortest paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> 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);
@@ -155,11 +155,11 @@
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///By default it is a NullMap.
 		    typedef NullMap<typename Digraph::Node,bool> 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
@@ -174,11 +174,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<typename LM::Value> 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);
@@ -327,10 +327,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 <class T>
 		    struct SetPredMap
 		      : public Dijkstra< Digraph, LengthMap, SetPredMapTraits<T> > {
@@ -347,10 +347,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 <class T>
 		    struct SetDistMap
 		      : public Dijkstra< Digraph, LengthMap, SetDistMapTraits<T> > {
@@ -367,10 +367,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 <class T>
 		    struct SetProcessedMap
 		      : public Dijkstra< Digraph, LengthMap, SetProcessedMapTraits<T> > {
@@ -385,10 +385,10 @@
+		      }
 		    };
 		    ///\brief \ref named-templ-param "Named parameter" for setting
-		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///
 		    ///\ref named-templ-param "Named parameter" for setting
-		    ///\ref ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///ProcessedMap type to be <tt>Digraph::NodeMap<bool></tt>.
 		    ///If you don't set it explicitly, it will be automatically allocated.
 		    struct SetStandardProcessedMap
 		      : public Dijkstra< Digraph, LengthMap, SetStandardProcessedMapTraits > {
@@ -986,11 +986,11 @@
 		    ///arcs of the shortest paths.
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    typedef typename Digraph::template NodeMap<typename Digraph::Arc> 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);
@@ -1002,11 +1002,11 @@
 		    ///It must meet the \ref concepts::WriteMap "WriteMap" concept.
 		    ///By default it is a NullMap.
 		    typedef NullMap<typename Digraph::Node,bool> 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
@@ -1021,11 +1021,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<typename LM::Value> 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);
@@ -1198,10 +1198,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<class T>
 		    DijkstraWizard<SetPredMapBase<T> > predMap(const T &t)
+		    {
@@ -1216,10 +1216,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<class T>
 		    DijkstraWizard<SetDistMapBase<T> > distMap(const T &t)
+		    {
@@ -1234,10 +1234,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<class T>
 		    DijkstraWizard<SetProcessedMapBase<T> > processedMap(const T &t)
+		    {

lemon/maps.h

Show inline comments

@@ -73,9 +73,9 @@
 		    void set(const Key&, const Value&) {}
 		  };
 		  /// Returns a \ref NullMap class
-		  /// This function just returns a \ref NullMap class.
+		  /// Returns a \c NullMap class
 		  /// This function just returns a \c NullMap class.
 		  /// \relates NullMap
 		  template <typename K, typename V>
 		  NullMap<K, V> nullMap() {
@@ -88,7 +88,7 @@
 		  /// This \ref concepts::ReadMap "readable map" assigns a specified
 		  /// value to each key.
 		  ///
-		  /// In other aspects it is equivalent to \ref NullMap.
+		  /// In other aspects it is equivalent to \c NullMap.
 		  /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
 		  /// concept, but it absorbs the data written to it.
 		  ///
@@ -133,9 +133,9 @@
 		    ConstMap(const ConstMap<K, V1> &, const Value &v) : _value(v) {}
 		  };
 		  /// Returns a \ref ConstMap class
-		  /// This function just returns a \ref ConstMap class.
+		  /// Returns a \c ConstMap class
 		  /// This function just returns a \c ConstMap class.
 		  /// \relates ConstMap
 		  template<typename K, typename V>
 		  inline ConstMap<K, V> constMap(const V &v) {
@@ -156,7 +156,7 @@
 		  /// This \ref concepts::ReadMap "readable map" assigns a specified
 		  /// value to each key.
 		  ///
-		  /// In other aspects it is equivalent to \ref NullMap.
+		  /// In other aspects it is equivalent to \c NullMap.
 		  /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
 		  /// concept, but it absorbs the data written to it.
 		  ///
@@ -182,9 +182,9 @@
 		    void set(const Key&, const Value&) {}
 		  };
 		  /// Returns a \ref ConstMap class with inlined constant value
-		  /// This function just returns a \ref ConstMap class with inlined
+		  /// Returns a \c ConstMap class with inlined constant value
 		  /// This function just returns a \c ConstMap class with inlined
 		  /// constant value.
 		  /// \relates ConstMap
 		  template<typename K, typename V, V v>
@@ -212,9 +212,9 @@
+		    }
 		  };
 		  /// Returns an \ref IdentityMap class
-		  /// This function just returns an \ref IdentityMap class.
+		  /// Returns an \c IdentityMap class
 		  /// This function just returns an \c IdentityMap class.
 		  /// \relates IdentityMap
 		  template<typename T>
 		  inline IdentityMap<T> identityMap() {
@@ -228,7 +228,7 @@
 		  /// This map is essentially a wrapper for \c std::vector. It assigns
 		  /// values to integer keys from the range <tt>[0..size-1]</tt>.
 		  /// It can be used with some data structures, for example
-		  /// \ref UnionFind, \ref BinHeap, when the used items are small
+		  /// \c UnionFind, \c BinHeap, when the used items are small
 		  /// integers. This map conforms the \ref concepts::ReferenceMap
 		  /// "ReferenceMap" concept.
 		  ///
@@ -268,7 +268,7 @@
 		    RangeMap(const std::vector<V1>& vector)
 		      : _vector(vector.begin(), vector.end()) {}
-		    /// Constructs the map from another \ref RangeMap.
+		    /// Constructs the map from another \c RangeMap.
 		    template <typename V1>
 		    RangeMap(const RangeMap<V1> &c)
 		      : _vector(c._vector.begin(), c._vector.end()) {}
@@ -311,19 +311,19 @@
+		    }
 		  };
 		  /// Returns a \ref RangeMap class
-		  /// This function just returns a \ref RangeMap class.
+		  /// Returns a \c RangeMap class
 		  /// This function just returns a \c RangeMap class.
 		  /// \relates RangeMap
 		  template<typename V>
 		  inline RangeMap<V> rangeMap(int size = 0, const V &value = V()) {
 		    return RangeMap<V>(size, value);
+		  }
-		  /// \brief Returns a \ref RangeMap class created from an appropriate
+		  /// \brief Returns a \c RangeMap class created from an appropriate
 		  /// \c std::vector
-		  /// This function just returns a \ref RangeMap class created from an
+		  /// This function just returns a \c RangeMap class created from an
 		  /// appropriate \c std::vector.
 		  /// \relates RangeMap
 		  template<typename V>
@@ -388,7 +388,7 @@
 		              const Value &value = Value())
 		      : _map(map.begin(), map.end()), _value(value) {}
-		    /// \brief Constructs the map from another \ref SparseMap.
+		    /// \brief Constructs the map from another \c SparseMap.
 		    template<typename V1, typename Comp1>
 		    SparseMap(const SparseMap<Key, V1, Comp1> &c)
 		      : _map(c._map.begin(), c._map.end()), _value(c._value) {}
@@ -433,9 +433,9 @@
+		    }
 		  };
 		  /// Returns a \ref SparseMap class
-		  /// This function just returns a \ref SparseMap class with specified
+		  /// Returns a \c SparseMap class
 		  /// This function just returns a \c SparseMap class with specified
 		  /// default value.
 		  /// \relates SparseMap
 		  template<typename K, typename V, typename Compare>
@@ -448,10 +448,10 @@
 		    return SparseMap<K, V, std::less<K> >(value);
+		  }
-		  /// \brief Returns a \ref SparseMap class created from an appropriate
+		  /// \brief Returns a \c SparseMap class created from an appropriate
 		  /// \c std::map
-		  /// This function just returns a \ref SparseMap class created from an
+		  /// This function just returns a \c SparseMap class created from an
 		  /// appropriate \c std::map.
 		  /// \relates SparseMap
 		  template<typename K, typename V, typename Compare>
@@ -501,9 +501,9 @@
 		    operator[](const Key &k) const { return _m1[_m2[k]]; }
 		  };
 		  /// Returns a \ref ComposeMap class
-		  /// This function just returns a \ref ComposeMap class.
+		  /// Returns a \c ComposeMap class
 		  /// This function just returns a \c ComposeMap class.
 		  ///
 		  /// If \c m1 and \c m2 are maps and the \c Value type of \c m2 is
 		  /// convertible to the \c Key of \c m1, then <tt>composeMap(m1,m2)[x]</tt>
@@ -556,9 +556,9 @@
 		    Value operator[](const Key &k) const { return _f(_m1[k],_m2[k]); }
 		  };
 		  /// Returns a \ref CombineMap class
-		  /// This function just returns a \ref CombineMap class.
+		  /// Returns a \c CombineMap class
 		  /// This function just returns a \c CombineMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c double
 		  /// values, then
@@ -625,9 +625,9 @@
 		    Value operator[](const Key &k) const { return _f(k); }
 		  };
 		  /// Returns a \ref FunctorToMap class
-		  /// This function just returns a \ref FunctorToMap class.
+		  /// Returns a \c FunctorToMap class
 		  /// This function just returns a \c FunctorToMap class.
 		  ///
 		  /// This function is specialized for adaptable binary function
 		  /// classes and C++ functions.
@@ -684,9 +684,9 @@
 		    Value operator[](const Key &k) const { return _m[k]; }
 		  };
 		  /// Returns a \ref MapToFunctor class
-		  /// This function just returns a \ref MapToFunctor class.
+		  /// Returns a \c MapToFunctor class
 		  /// This function just returns a \c MapToFunctor class.
 		  /// \relates MapToFunctor
 		  template<typename M>
 		  inline MapToFunctor<M> mapToFunctor(const M &m) {
@@ -723,9 +723,9 @@
 		    Value operator[](const Key &k) const { return _m[k]; }
 		  };
 		  /// Returns a \ref ConvertMap class
-		  /// This function just returns a \ref ConvertMap class.
+		  /// Returns a \c ConvertMap class
 		  /// This function just returns a \c ConvertMap class.
 		  /// \relates ConvertMap
 		  template<typename V, typename M>
 		  inline ConvertMap<M, V> convertMap(const M &map) {
@@ -763,9 +763,9 @@
 		    void set(const Key &k, const Value &v) { _m1.set(k,v); _m2.set(k,v); }
 		  };
 		  /// Returns a \ref ForkMap class
-		  /// This function just returns a \ref ForkMap class.
+		  /// Returns a \c ForkMap class
 		  /// This function just returns a \c ForkMap class.
 		  /// \relates ForkMap
 		  template <typename M1, typename M2>
 		  inline ForkMap<M1,M2> forkMap(M1 &m1, M2 &m2) {
@@ -807,9 +807,9 @@
 		    Value operator[](const Key &k) const { return _m1[k]+_m2[k]; }
 		  };
 		  /// Returns an \ref AddMap class
-		  /// This function just returns an \ref AddMap class.
+		  /// Returns an \c AddMap class
 		  /// This function just returns an \c AddMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c double
 		  /// values, then <tt>addMap(m1,m2)[x]</tt> will be equal to
@@ -855,9 +855,9 @@
 		    Value operator[](const Key &k) const { return _m1[k]-_m2[k]; }
 		  };
 		  /// Returns a \ref SubMap class
-		  /// This function just returns a \ref SubMap class.
+		  /// Returns a \c SubMap class
 		  /// This function just returns a \c SubMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c double
 		  /// values, then <tt>subMap(m1,m2)[x]</tt> will be equal to
@@ -904,9 +904,9 @@
 		    Value operator[](const Key &k) const { return _m1[k]*_m2[k]; }
 		  };
 		  /// Returns a \ref MulMap class
-		  /// This function just returns a \ref MulMap class.
+		  /// Returns a \c MulMap class
 		  /// This function just returns a \c MulMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c double
 		  /// values, then <tt>mulMap(m1,m2)[x]</tt> will be equal to
@@ -952,9 +952,9 @@
 		    Value operator[](const Key &k) const { return _m1[k]/_m2[k]; }
 		  };
 		  /// Returns a \ref DivMap class
-		  /// This function just returns a \ref DivMap class.
+		  /// Returns a \c DivMap class
 		  /// This function just returns a \c DivMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c double
 		  /// values, then <tt>divMap(m1,m2)[x]</tt> will be equal to
@@ -1038,9 +1038,9 @@
 		    void set(const Key &k, const Value &v) { _m.set(k, v-_v); }
 		  };
 		  /// Returns a \ref ShiftMap class
-		  /// This function just returns a \ref ShiftMap class.
+		  /// Returns a \c ShiftMap class
 		  /// This function just returns a \c ShiftMap class.
 		  ///
 		  /// For example, if \c m is a map with \c double values and \c v is
 		  /// \c double, then <tt>shiftMap(m,v)[x]</tt> will be equal to
@@ -1052,9 +1052,9 @@
 		    return ShiftMap<M, C>(m,v);
+		  }
 		  /// Returns a \ref ShiftWriteMap class
-		  /// This function just returns a \ref ShiftWriteMap class.
+		  /// Returns a \c ShiftWriteMap class
 		  /// This function just returns a \c ShiftWriteMap class.
 		  ///
 		  /// For example, if \c m is a map with \c double values and \c v is
 		  /// \c double, then <tt>shiftWriteMap(m,v)[x]</tt> will be equal to
@@ -1140,9 +1140,9 @@
 		    void set(const Key &k, const Value &v) { _m.set(k, v/_v); }
 		  };
 		  /// Returns a \ref ScaleMap class
-		  /// This function just returns a \ref ScaleMap class.
+		  /// Returns a \c ScaleMap class
 		  /// This function just returns a \c ScaleMap class.
 		  ///
 		  /// For example, if \c m is a map with \c double values and \c v is
 		  /// \c double, then <tt>scaleMap(m,v)[x]</tt> will be equal to
@@ -1154,9 +1154,9 @@
 		    return ScaleMap<M, C>(m,v);
+		  }
 		  /// Returns a \ref ScaleWriteMap class
-		  /// This function just returns a \ref ScaleWriteMap class.
+		  /// Returns a \c ScaleWriteMap class
 		  /// This function just returns a \c ScaleWriteMap class.
 		  ///
 		  /// For example, if \c m is a map with \c double values and \c v is
 		  /// \c double, then <tt>scaleWriteMap(m,v)[x]</tt> will be equal to
@@ -1240,9 +1240,9 @@
 		    void set(const Key &k, const Value &v) { _m.set(k, -v); }
 		  };
 		  /// Returns a \ref NegMap class
-		  /// This function just returns a \ref NegMap class.
+		  /// Returns a \c NegMap class
 		  /// This function just returns a \c NegMap class.
 		  ///
 		  /// For example, if \c m is a map with \c double values, then
 		  /// <tt>negMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
@@ -1253,9 +1253,9 @@
 		    return NegMap<M>(m);
+		  }
 		  /// Returns a \ref NegWriteMap class
-		  /// This function just returns a \ref NegWriteMap class.
+		  /// Returns a \c NegWriteMap class
 		  /// This function just returns a \c NegWriteMap class.
 		  ///
 		  /// For example, if \c m is a map with \c double values, then
 		  /// <tt>negWriteMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
@@ -1296,9 +1296,9 @@
 		  };
 		  /// Returns an \ref AbsMap class
-		  /// This function just returns an \ref AbsMap class.
+		  /// Returns an \c AbsMap class
 		  /// This function just returns an \c AbsMap class.
 		  ///
 		  /// For example, if \c m is a map with \c double values, then
 		  /// <tt>absMap(m)[x]</tt> will be equal to <tt>m[x]</tt> if
@@ -1345,9 +1345,9 @@
 		    Value operator[](const Key&) const { return true; }
 		  };
 		  /// Returns a \ref TrueMap class
-		  /// This function just returns a \ref TrueMap class.
+		  /// Returns a \c TrueMap class
 		  /// This function just returns a \c TrueMap class.
 		  /// \relates TrueMap
 		  template<typename K>
 		  inline TrueMap<K> trueMap() {
@@ -1382,9 +1382,9 @@
 		    Value operator[](const Key&) const { return false; }
 		  };
 		  /// Returns a \ref FalseMap class
-		  /// This function just returns a \ref FalseMap class.
+		  /// Returns a \c FalseMap class
 		  /// This function just returns a \c FalseMap class.
 		  /// \relates FalseMap
 		  template<typename K>
 		  inline FalseMap<K> falseMap() {
@@ -1429,9 +1429,9 @@
 		    Value operator[](const Key &k) const { return _m1[k]&&_m2[k]; }
 		  };
 		  /// Returns an \ref AndMap class
-		  /// This function just returns an \ref AndMap class.
+		  /// Returns an \c AndMap class
 		  /// This function just returns an \c AndMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c bool values,
 		  /// then <tt>andMap(m1,m2)[x]</tt> will be equal to
@@ -1477,9 +1477,9 @@
 		    Value operator[](const Key &k) const { return _m1[k]||_m2[k]; }
 		  };
 		  /// Returns an \ref OrMap class
-		  /// This function just returns an \ref OrMap class.
+		  /// Returns an \c OrMap class
 		  /// This function just returns an \c OrMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are both maps with \c bool values,
 		  /// then <tt>orMap(m1,m2)[x]</tt> will be equal to
@@ -1544,9 +1544,9 @@
 		    void set(const Key &k, bool v) { _m.set(k, !v); }
 		  };
 		  /// Returns a \ref NotMap class
-		  /// This function just returns a \ref NotMap class.
+		  /// Returns a \c NotMap class
 		  /// This function just returns a \c NotMap class.
 		  ///
 		  /// For example, if \c m is a map with \c bool values, then
 		  /// <tt>notMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
@@ -1557,9 +1557,9 @@
 		    return NotMap<M>(m);
+		  }
 		  /// Returns a \ref NotWriteMap class
-		  /// This function just returns a \ref NotWriteMap class.
+		  /// Returns a \c NotWriteMap class
 		  /// This function just returns a \c NotWriteMap class.
 		  ///
 		  /// For example, if \c m is a map with \c bool values, then
 		  /// <tt>notWriteMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
@@ -1605,9 +1605,9 @@
 		    Value operator[](const Key &k) const { return _m1[k]==_m2[k]; }
 		  };
 		  /// Returns an \ref EqualMap class
-		  /// This function just returns an \ref EqualMap class.
+		  /// Returns an \c EqualMap class
 		  /// This function just returns an \c EqualMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are maps with keys and values of
 		  /// the same type, then <tt>equalMap(m1,m2)[x]</tt> will be equal to
@@ -1653,9 +1653,9 @@
 		    Value operator[](const Key &k) const { return _m1[k]<_m2[k]; }
 		  };
 		  /// Returns an \ref LessMap class
-		  /// This function just returns an \ref LessMap class.
+		  /// Returns an \c LessMap class
 		  /// This function just returns an \c LessMap class.
 		  ///
 		  /// For example, if \c m1 and \c m2 are maps with keys and values of
 		  /// the same type, then <tt>lessMap(m1,m2)[x]</tt> will be equal to
@@ -1745,9 +1745,9 @@
 		    Iterator _end;
 		  };
 		  /// Returns a \ref LoggerBoolMap class
-		  /// This function just returns a \ref LoggerBoolMap class.
+		  /// Returns a \c LoggerBoolMap class
 		  /// This function just returns a \c LoggerBoolMap class.
 		  ///
 		  /// The most important usage of it is storing certain nodes or arcs
 		  /// that were marked \c true by an algorithm.
@@ -1767,7 +1767,7 @@
 		  ///
 		  /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
 		  /// it cannot be used when a readable map is needed, for example as
-		  /// \c ReachedMap for \ref Bfs, \ref Dfs and \ref Dijkstra algorithms.
+		  /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.
 		  ///
 		  /// \relates LoggerBoolMap
 		  template<typename Iterator>
@@ -2282,9 +2282,9 @@
 		    const Digraph& _digraph;
 		  };
-		  /// \brief Returns a \ref SourceMap class.
+		  /// \brief Returns a \c SourceMap class.
 		  ///
-		  /// This function just returns an \ref SourceMap class.
+		  /// This function just returns an \c SourceMap class.
 		  /// \relates SourceMap
 		  template <typename Digraph>
 		  inline SourceMap<Digraph> sourceMap(const Digraph& digraph) {
@@ -2321,9 +2321,9 @@
 		    const Digraph& _digraph;
 		  };
-		  /// \brief Returns a \ref TargetMap class.
+		  /// \brief Returns a \c TargetMap class.
 		  ///
-		  /// This function just returns a \ref TargetMap class.
+		  /// This function just returns a \c TargetMap class.
 		  /// \relates TargetMap
 		  template <typename Digraph>
 		  inline TargetMap<Digraph> targetMap(const Digraph& digraph) {
@@ -2360,9 +2360,9 @@
 		    const Graph& _graph;
 		  };
-		  /// \brief Returns a \ref ForwardMap class.
+		  /// \brief Returns a \c ForwardMap class.
 		  ///
-		  /// This function just returns an \ref ForwardMap class.
+		  /// This function just returns an \c ForwardMap class.
 		  /// \relates ForwardMap
 		  template <typename Graph>
 		  inline ForwardMap<Graph> forwardMap(const Graph& graph) {
@@ -2399,9 +2399,9 @@
 		    const Graph& _graph;
 		  };
 		  /// \brief Returns a \ref BackwardMap class
-		  /// This function just returns a \ref BackwardMap class.
+		  /// \brief Returns a \c BackwardMap class
 		  /// This function just returns a \c BackwardMap class.
 		  /// \relates BackwardMap
 		  template <typename Graph>
 		  inline BackwardMap<Graph> backwardMap(const Graph& graph) {

0 comments (0 inline)

RhodeCode

Login to your account