1.1 --- a/lemon/maps.h Thu Oct 09 16:47:01 2008 +0200
1.2 +++ b/lemon/maps.h Thu Oct 09 16:20:37 2008 +0100
1.3 @@ -43,7 +43,7 @@
1.4 template<typename K, typename V>
1.5 class MapBase {
1.6 public:
1.7 - /// \biref The key type of the map.
1.8 + /// \brief The key type of the map.
1.9 typedef K Key;
1.10 /// \brief The value type of the map.
1.11 /// (The type of objects associated with the keys).
1.12 @@ -73,9 +73,9 @@
1.13 void set(const Key&, const Value&) {}
1.14 };
1.15
1.16 - /// Returns a \ref NullMap class
1.17 -
1.18 - /// This function just returns a \ref NullMap class.
1.19 + /// Returns a \c NullMap class
1.20 +
1.21 + /// This function just returns a \c NullMap class.
1.22 /// \relates NullMap
1.23 template <typename K, typename V>
1.24 NullMap<K, V> nullMap() {
1.25 @@ -88,7 +88,7 @@
1.26 /// This \ref concepts::ReadMap "readable map" assigns a specified
1.27 /// value to each key.
1.28 ///
1.29 - /// In other aspects it is equivalent to \ref NullMap.
1.30 + /// In other aspects it is equivalent to \c NullMap.
1.31 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
1.32 /// concept, but it absorbs the data written to it.
1.33 ///
1.34 @@ -133,9 +133,9 @@
1.35 ConstMap(const ConstMap<K, V1> &, const Value &v) : _value(v) {}
1.36 };
1.37
1.38 - /// Returns a \ref ConstMap class
1.39 -
1.40 - /// This function just returns a \ref ConstMap class.
1.41 + /// Returns a \c ConstMap class
1.42 +
1.43 + /// This function just returns a \c ConstMap class.
1.44 /// \relates ConstMap
1.45 template<typename K, typename V>
1.46 inline ConstMap<K, V> constMap(const V &v) {
1.47 @@ -156,7 +156,7 @@
1.48 /// This \ref concepts::ReadMap "readable map" assigns a specified
1.49 /// value to each key.
1.50 ///
1.51 - /// In other aspects it is equivalent to \ref NullMap.
1.52 + /// In other aspects it is equivalent to \c NullMap.
1.53 /// So it conforms the \ref concepts::ReadWriteMap "ReadWriteMap"
1.54 /// concept, but it absorbs the data written to it.
1.55 ///
1.56 @@ -182,9 +182,9 @@
1.57 void set(const Key&, const Value&) {}
1.58 };
1.59
1.60 - /// Returns a \ref ConstMap class with inlined constant value
1.61 -
1.62 - /// This function just returns a \ref ConstMap class with inlined
1.63 + /// Returns a \c ConstMap class with inlined constant value
1.64 +
1.65 + /// This function just returns a \c ConstMap class with inlined
1.66 /// constant value.
1.67 /// \relates ConstMap
1.68 template<typename K, typename V, V v>
1.69 @@ -212,9 +212,9 @@
1.70 }
1.71 };
1.72
1.73 - /// Returns an \ref IdentityMap class
1.74 -
1.75 - /// This function just returns an \ref IdentityMap class.
1.76 + /// Returns an \c IdentityMap class
1.77 +
1.78 + /// This function just returns an \c IdentityMap class.
1.79 /// \relates IdentityMap
1.80 template<typename T>
1.81 inline IdentityMap<T> identityMap() {
1.82 @@ -228,7 +228,7 @@
1.83 /// This map is essentially a wrapper for \c std::vector. It assigns
1.84 /// values to integer keys from the range <tt>[0..size-1]</tt>.
1.85 /// It can be used with some data structures, for example
1.86 - /// \ref UnionFind, \ref BinHeap, when the used items are small
1.87 + /// \c UnionFind, \c BinHeap, when the used items are small
1.88 /// integers. This map conforms the \ref concepts::ReferenceMap
1.89 /// "ReferenceMap" concept.
1.90 ///
1.91 @@ -268,7 +268,7 @@
1.92 RangeMap(const std::vector<V1>& vector)
1.93 : _vector(vector.begin(), vector.end()) {}
1.94
1.95 - /// Constructs the map from another \ref RangeMap.
1.96 + /// Constructs the map from another \c RangeMap.
1.97 template <typename V1>
1.98 RangeMap(const RangeMap<V1> &c)
1.99 : _vector(c._vector.begin(), c._vector.end()) {}
1.100 @@ -311,19 +311,19 @@
1.101 }
1.102 };
1.103
1.104 - /// Returns a \ref RangeMap class
1.105 -
1.106 - /// This function just returns a \ref RangeMap class.
1.107 + /// Returns a \c RangeMap class
1.108 +
1.109 + /// This function just returns a \c RangeMap class.
1.110 /// \relates RangeMap
1.111 template<typename V>
1.112 inline RangeMap<V> rangeMap(int size = 0, const V &value = V()) {
1.113 return RangeMap<V>(size, value);
1.114 }
1.115
1.116 - /// \brief Returns a \ref RangeMap class created from an appropriate
1.117 + /// \brief Returns a \c RangeMap class created from an appropriate
1.118 /// \c std::vector
1.119
1.120 - /// This function just returns a \ref RangeMap class created from an
1.121 + /// This function just returns a \c RangeMap class created from an
1.122 /// appropriate \c std::vector.
1.123 /// \relates RangeMap
1.124 template<typename V>
1.125 @@ -388,7 +388,7 @@
1.126 const Value &value = Value())
1.127 : _map(map.begin(), map.end()), _value(value) {}
1.128
1.129 - /// \brief Constructs the map from another \ref SparseMap.
1.130 + /// \brief Constructs the map from another \c SparseMap.
1.131 template<typename V1, typename Comp1>
1.132 SparseMap(const SparseMap<Key, V1, Comp1> &c)
1.133 : _map(c._map.begin(), c._map.end()), _value(c._value) {}
1.134 @@ -433,9 +433,9 @@
1.135 }
1.136 };
1.137
1.138 - /// Returns a \ref SparseMap class
1.139 -
1.140 - /// This function just returns a \ref SparseMap class with specified
1.141 + /// Returns a \c SparseMap class
1.142 +
1.143 + /// This function just returns a \c SparseMap class with specified
1.144 /// default value.
1.145 /// \relates SparseMap
1.146 template<typename K, typename V, typename Compare>
1.147 @@ -448,10 +448,10 @@
1.148 return SparseMap<K, V, std::less<K> >(value);
1.149 }
1.150
1.151 - /// \brief Returns a \ref SparseMap class created from an appropriate
1.152 + /// \brief Returns a \c SparseMap class created from an appropriate
1.153 /// \c std::map
1.154
1.155 - /// This function just returns a \ref SparseMap class created from an
1.156 + /// This function just returns a \c SparseMap class created from an
1.157 /// appropriate \c std::map.
1.158 /// \relates SparseMap
1.159 template<typename K, typename V, typename Compare>
1.160 @@ -501,9 +501,9 @@
1.161 operator[](const Key &k) const { return _m1[_m2[k]]; }
1.162 };
1.163
1.164 - /// Returns a \ref ComposeMap class
1.165 -
1.166 - /// This function just returns a \ref ComposeMap class.
1.167 + /// Returns a \c ComposeMap class
1.168 +
1.169 + /// This function just returns a \c ComposeMap class.
1.170 ///
1.171 /// If \c m1 and \c m2 are maps and the \c Value type of \c m2 is
1.172 /// convertible to the \c Key of \c m1, then <tt>composeMap(m1,m2)[x]</tt>
1.173 @@ -556,9 +556,9 @@
1.174 Value operator[](const Key &k) const { return _f(_m1[k],_m2[k]); }
1.175 };
1.176
1.177 - /// Returns a \ref CombineMap class
1.178 -
1.179 - /// This function just returns a \ref CombineMap class.
1.180 + /// Returns a \c CombineMap class
1.181 +
1.182 + /// This function just returns a \c CombineMap class.
1.183 ///
1.184 /// For example, if \c m1 and \c m2 are both maps with \c double
1.185 /// values, then
1.186 @@ -625,9 +625,9 @@
1.187 Value operator[](const Key &k) const { return _f(k); }
1.188 };
1.189
1.190 - /// Returns a \ref FunctorToMap class
1.191 -
1.192 - /// This function just returns a \ref FunctorToMap class.
1.193 + /// Returns a \c FunctorToMap class
1.194 +
1.195 + /// This function just returns a \c FunctorToMap class.
1.196 ///
1.197 /// This function is specialized for adaptable binary function
1.198 /// classes and C++ functions.
1.199 @@ -684,9 +684,9 @@
1.200 Value operator[](const Key &k) const { return _m[k]; }
1.201 };
1.202
1.203 - /// Returns a \ref MapToFunctor class
1.204 -
1.205 - /// This function just returns a \ref MapToFunctor class.
1.206 + /// Returns a \c MapToFunctor class
1.207 +
1.208 + /// This function just returns a \c MapToFunctor class.
1.209 /// \relates MapToFunctor
1.210 template<typename M>
1.211 inline MapToFunctor<M> mapToFunctor(const M &m) {
1.212 @@ -723,9 +723,9 @@
1.213 Value operator[](const Key &k) const { return _m[k]; }
1.214 };
1.215
1.216 - /// Returns a \ref ConvertMap class
1.217 -
1.218 - /// This function just returns a \ref ConvertMap class.
1.219 + /// Returns a \c ConvertMap class
1.220 +
1.221 + /// This function just returns a \c ConvertMap class.
1.222 /// \relates ConvertMap
1.223 template<typename V, typename M>
1.224 inline ConvertMap<M, V> convertMap(const M &map) {
1.225 @@ -763,9 +763,9 @@
1.226 void set(const Key &k, const Value &v) { _m1.set(k,v); _m2.set(k,v); }
1.227 };
1.228
1.229 - /// Returns a \ref ForkMap class
1.230 -
1.231 - /// This function just returns a \ref ForkMap class.
1.232 + /// Returns a \c ForkMap class
1.233 +
1.234 + /// This function just returns a \c ForkMap class.
1.235 /// \relates ForkMap
1.236 template <typename M1, typename M2>
1.237 inline ForkMap<M1,M2> forkMap(M1 &m1, M2 &m2) {
1.238 @@ -807,9 +807,9 @@
1.239 Value operator[](const Key &k) const { return _m1[k]+_m2[k]; }
1.240 };
1.241
1.242 - /// Returns an \ref AddMap class
1.243 -
1.244 - /// This function just returns an \ref AddMap class.
1.245 + /// Returns an \c AddMap class
1.246 +
1.247 + /// This function just returns an \c AddMap class.
1.248 ///
1.249 /// For example, if \c m1 and \c m2 are both maps with \c double
1.250 /// values, then <tt>addMap(m1,m2)[x]</tt> will be equal to
1.251 @@ -855,9 +855,9 @@
1.252 Value operator[](const Key &k) const { return _m1[k]-_m2[k]; }
1.253 };
1.254
1.255 - /// Returns a \ref SubMap class
1.256 -
1.257 - /// This function just returns a \ref SubMap class.
1.258 + /// Returns a \c SubMap class
1.259 +
1.260 + /// This function just returns a \c SubMap class.
1.261 ///
1.262 /// For example, if \c m1 and \c m2 are both maps with \c double
1.263 /// values, then <tt>subMap(m1,m2)[x]</tt> will be equal to
1.264 @@ -904,9 +904,9 @@
1.265 Value operator[](const Key &k) const { return _m1[k]*_m2[k]; }
1.266 };
1.267
1.268 - /// Returns a \ref MulMap class
1.269 -
1.270 - /// This function just returns a \ref MulMap class.
1.271 + /// Returns a \c MulMap class
1.272 +
1.273 + /// This function just returns a \c MulMap class.
1.274 ///
1.275 /// For example, if \c m1 and \c m2 are both maps with \c double
1.276 /// values, then <tt>mulMap(m1,m2)[x]</tt> will be equal to
1.277 @@ -952,9 +952,9 @@
1.278 Value operator[](const Key &k) const { return _m1[k]/_m2[k]; }
1.279 };
1.280
1.281 - /// Returns a \ref DivMap class
1.282 -
1.283 - /// This function just returns a \ref DivMap class.
1.284 + /// Returns a \c DivMap class
1.285 +
1.286 + /// This function just returns a \c DivMap class.
1.287 ///
1.288 /// For example, if \c m1 and \c m2 are both maps with \c double
1.289 /// values, then <tt>divMap(m1,m2)[x]</tt> will be equal to
1.290 @@ -1038,9 +1038,9 @@
1.291 void set(const Key &k, const Value &v) { _m.set(k, v-_v); }
1.292 };
1.293
1.294 - /// Returns a \ref ShiftMap class
1.295 -
1.296 - /// This function just returns a \ref ShiftMap class.
1.297 + /// Returns a \c ShiftMap class
1.298 +
1.299 + /// This function just returns a \c ShiftMap class.
1.300 ///
1.301 /// For example, if \c m is a map with \c double values and \c v is
1.302 /// \c double, then <tt>shiftMap(m,v)[x]</tt> will be equal to
1.303 @@ -1052,9 +1052,9 @@
1.304 return ShiftMap<M, C>(m,v);
1.305 }
1.306
1.307 - /// Returns a \ref ShiftWriteMap class
1.308 -
1.309 - /// This function just returns a \ref ShiftWriteMap class.
1.310 + /// Returns a \c ShiftWriteMap class
1.311 +
1.312 + /// This function just returns a \c ShiftWriteMap class.
1.313 ///
1.314 /// For example, if \c m is a map with \c double values and \c v is
1.315 /// \c double, then <tt>shiftWriteMap(m,v)[x]</tt> will be equal to
1.316 @@ -1140,9 +1140,9 @@
1.317 void set(const Key &k, const Value &v) { _m.set(k, v/_v); }
1.318 };
1.319
1.320 - /// Returns a \ref ScaleMap class
1.321 -
1.322 - /// This function just returns a \ref ScaleMap class.
1.323 + /// Returns a \c ScaleMap class
1.324 +
1.325 + /// This function just returns a \c ScaleMap class.
1.326 ///
1.327 /// For example, if \c m is a map with \c double values and \c v is
1.328 /// \c double, then <tt>scaleMap(m,v)[x]</tt> will be equal to
1.329 @@ -1154,9 +1154,9 @@
1.330 return ScaleMap<M, C>(m,v);
1.331 }
1.332
1.333 - /// Returns a \ref ScaleWriteMap class
1.334 -
1.335 - /// This function just returns a \ref ScaleWriteMap class.
1.336 + /// Returns a \c ScaleWriteMap class
1.337 +
1.338 + /// This function just returns a \c ScaleWriteMap class.
1.339 ///
1.340 /// For example, if \c m is a map with \c double values and \c v is
1.341 /// \c double, then <tt>scaleWriteMap(m,v)[x]</tt> will be equal to
1.342 @@ -1240,9 +1240,9 @@
1.343 void set(const Key &k, const Value &v) { _m.set(k, -v); }
1.344 };
1.345
1.346 - /// Returns a \ref NegMap class
1.347 -
1.348 - /// This function just returns a \ref NegMap class.
1.349 + /// Returns a \c NegMap class
1.350 +
1.351 + /// This function just returns a \c NegMap class.
1.352 ///
1.353 /// For example, if \c m is a map with \c double values, then
1.354 /// <tt>negMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
1.355 @@ -1253,9 +1253,9 @@
1.356 return NegMap<M>(m);
1.357 }
1.358
1.359 - /// Returns a \ref NegWriteMap class
1.360 -
1.361 - /// This function just returns a \ref NegWriteMap class.
1.362 + /// Returns a \c NegWriteMap class
1.363 +
1.364 + /// This function just returns a \c NegWriteMap class.
1.365 ///
1.366 /// For example, if \c m is a map with \c double values, then
1.367 /// <tt>negWriteMap(m)[x]</tt> will be equal to <tt>-m[x]</tt>.
1.368 @@ -1296,9 +1296,9 @@
1.369
1.370 };
1.371
1.372 - /// Returns an \ref AbsMap class
1.373 -
1.374 - /// This function just returns an \ref AbsMap class.
1.375 + /// Returns an \c AbsMap class
1.376 +
1.377 + /// This function just returns an \c AbsMap class.
1.378 ///
1.379 /// For example, if \c m is a map with \c double values, then
1.380 /// <tt>absMap(m)[x]</tt> will be equal to <tt>m[x]</tt> if
1.381 @@ -1345,9 +1345,9 @@
1.382 Value operator[](const Key&) const { return true; }
1.383 };
1.384
1.385 - /// Returns a \ref TrueMap class
1.386 -
1.387 - /// This function just returns a \ref TrueMap class.
1.388 + /// Returns a \c TrueMap class
1.389 +
1.390 + /// This function just returns a \c TrueMap class.
1.391 /// \relates TrueMap
1.392 template<typename K>
1.393 inline TrueMap<K> trueMap() {
1.394 @@ -1382,9 +1382,9 @@
1.395 Value operator[](const Key&) const { return false; }
1.396 };
1.397
1.398 - /// Returns a \ref FalseMap class
1.399 -
1.400 - /// This function just returns a \ref FalseMap class.
1.401 + /// Returns a \c FalseMap class
1.402 +
1.403 + /// This function just returns a \c FalseMap class.
1.404 /// \relates FalseMap
1.405 template<typename K>
1.406 inline FalseMap<K> falseMap() {
1.407 @@ -1429,9 +1429,9 @@
1.408 Value operator[](const Key &k) const { return _m1[k]&&_m2[k]; }
1.409 };
1.410
1.411 - /// Returns an \ref AndMap class
1.412 -
1.413 - /// This function just returns an \ref AndMap class.
1.414 + /// Returns an \c AndMap class
1.415 +
1.416 + /// This function just returns an \c AndMap class.
1.417 ///
1.418 /// For example, if \c m1 and \c m2 are both maps with \c bool values,
1.419 /// then <tt>andMap(m1,m2)[x]</tt> will be equal to
1.420 @@ -1477,9 +1477,9 @@
1.421 Value operator[](const Key &k) const { return _m1[k]||_m2[k]; }
1.422 };
1.423
1.424 - /// Returns an \ref OrMap class
1.425 -
1.426 - /// This function just returns an \ref OrMap class.
1.427 + /// Returns an \c OrMap class
1.428 +
1.429 + /// This function just returns an \c OrMap class.
1.430 ///
1.431 /// For example, if \c m1 and \c m2 are both maps with \c bool values,
1.432 /// then <tt>orMap(m1,m2)[x]</tt> will be equal to
1.433 @@ -1544,9 +1544,9 @@
1.434 void set(const Key &k, bool v) { _m.set(k, !v); }
1.435 };
1.436
1.437 - /// Returns a \ref NotMap class
1.438 -
1.439 - /// This function just returns a \ref NotMap class.
1.440 + /// Returns a \c NotMap class
1.441 +
1.442 + /// This function just returns a \c NotMap class.
1.443 ///
1.444 /// For example, if \c m is a map with \c bool values, then
1.445 /// <tt>notMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
1.446 @@ -1557,9 +1557,9 @@
1.447 return NotMap<M>(m);
1.448 }
1.449
1.450 - /// Returns a \ref NotWriteMap class
1.451 -
1.452 - /// This function just returns a \ref NotWriteMap class.
1.453 + /// Returns a \c NotWriteMap class
1.454 +
1.455 + /// This function just returns a \c NotWriteMap class.
1.456 ///
1.457 /// For example, if \c m is a map with \c bool values, then
1.458 /// <tt>notWriteMap(m)[x]</tt> will be equal to <tt>!m[x]</tt>.
1.459 @@ -1605,9 +1605,9 @@
1.460 Value operator[](const Key &k) const { return _m1[k]==_m2[k]; }
1.461 };
1.462
1.463 - /// Returns an \ref EqualMap class
1.464 -
1.465 - /// This function just returns an \ref EqualMap class.
1.466 + /// Returns an \c EqualMap class
1.467 +
1.468 + /// This function just returns an \c EqualMap class.
1.469 ///
1.470 /// For example, if \c m1 and \c m2 are maps with keys and values of
1.471 /// the same type, then <tt>equalMap(m1,m2)[x]</tt> will be equal to
1.472 @@ -1653,9 +1653,9 @@
1.473 Value operator[](const Key &k) const { return _m1[k]<_m2[k]; }
1.474 };
1.475
1.476 - /// Returns an \ref LessMap class
1.477 -
1.478 - /// This function just returns an \ref LessMap class.
1.479 + /// Returns an \c LessMap class
1.480 +
1.481 + /// This function just returns an \c LessMap class.
1.482 ///
1.483 /// For example, if \c m1 and \c m2 are maps with keys and values of
1.484 /// the same type, then <tt>lessMap(m1,m2)[x]</tt> will be equal to
1.485 @@ -1683,6 +1683,11 @@
1.486
1.487 }
1.488
1.489 + /// @}
1.490 +
1.491 + /// \addtogroup maps
1.492 + /// @{
1.493 +
1.494 /// \brief Writable bool map for logging each \c true assigned element
1.495 ///
1.496 /// A \ref concepts::WriteMap "writable" bool map for logging
1.497 @@ -1745,9 +1750,9 @@
1.498 Iterator _end;
1.499 };
1.500
1.501 - /// Returns a \ref LoggerBoolMap class
1.502 -
1.503 - /// This function just returns a \ref LoggerBoolMap class.
1.504 + /// Returns a \c LoggerBoolMap class
1.505 +
1.506 + /// This function just returns a \c LoggerBoolMap class.
1.507 ///
1.508 /// The most important usage of it is storing certain nodes or arcs
1.509 /// that were marked \c true by an algorithm.
1.510 @@ -1767,7 +1772,7 @@
1.511 ///
1.512 /// \note LoggerBoolMap is just \ref concepts::WriteMap "writable", so
1.513 /// it cannot be used when a readable map is needed, for example as
1.514 - /// \c ReachedMap for \ref Bfs, \ref Dfs and \ref Dijkstra algorithms.
1.515 + /// \c ReachedMap for \c Bfs, \c Dfs and \c Dijkstra algorithms.
1.516 ///
1.517 /// \relates LoggerBoolMap
1.518 template<typename Iterator>
1.519 @@ -1775,6 +1780,11 @@
1.520 return LoggerBoolMap<Iterator>(it);
1.521 }
1.522
1.523 + /// @}
1.524 +
1.525 + /// \addtogroup graph_maps
1.526 + /// @{
1.527 +
1.528 /// Provides an immutable and unique id for each item in the graph.
1.529
1.530 /// The IdMap class provides a unique and immutable id for each item of the
1.531 @@ -1882,8 +1892,6 @@
1.532 /// The value type of the InvertableMap.
1.533 typedef typename Map::Value Value;
1.534
1.535 -
1.536 -
1.537 /// \brief Constructor.
1.538 ///
1.539 /// Construct a new InvertableMap for the graph.
1.540 @@ -2049,8 +2057,6 @@
1.541 return InverseMap(*this);
1.542 }
1.543
1.544 -
1.545 -
1.546 };
1.547
1.548 /// \brief Provides a mutable, continuous and unique descriptor for each
1.549 @@ -2266,7 +2272,7 @@
1.550 /// \brief Constructor
1.551 ///
1.552 /// Constructor
1.553 - /// \param _digraph The digraph that the map belongs to.
1.554 + /// \param digraph The digraph that the map belongs to.
1.555 explicit SourceMap(const Digraph& digraph) : _digraph(digraph) {}
1.556
1.557 /// \brief The subscript operator.
1.558 @@ -2282,9 +2288,9 @@
1.559 const Digraph& _digraph;
1.560 };
1.561
1.562 - /// \brief Returns a \ref SourceMap class.
1.563 + /// \brief Returns a \c SourceMap class.
1.564 ///
1.565 - /// This function just returns an \ref SourceMap class.
1.566 + /// This function just returns an \c SourceMap class.
1.567 /// \relates SourceMap
1.568 template <typename Digraph>
1.569 inline SourceMap<Digraph> sourceMap(const Digraph& digraph) {
1.570 @@ -2305,7 +2311,7 @@
1.571 /// \brief Constructor
1.572 ///
1.573 /// Constructor
1.574 - /// \param _digraph The digraph that the map belongs to.
1.575 + /// \param digraph The digraph that the map belongs to.
1.576 explicit TargetMap(const Digraph& digraph) : _digraph(digraph) {}
1.577
1.578 /// \brief The subscript operator.
1.579 @@ -2321,9 +2327,9 @@
1.580 const Digraph& _digraph;
1.581 };
1.582
1.583 - /// \brief Returns a \ref TargetMap class.
1.584 + /// \brief Returns a \c TargetMap class.
1.585 ///
1.586 - /// This function just returns a \ref TargetMap class.
1.587 + /// This function just returns a \c TargetMap class.
1.588 /// \relates TargetMap
1.589 template <typename Digraph>
1.590 inline TargetMap<Digraph> targetMap(const Digraph& digraph) {
1.591 @@ -2344,7 +2350,7 @@
1.592 /// \brief Constructor
1.593 ///
1.594 /// Constructor
1.595 - /// \param _graph The graph that the map belongs to.
1.596 + /// \param graph The graph that the map belongs to.
1.597 explicit ForwardMap(const Graph& graph) : _graph(graph) {}
1.598
1.599 /// \brief The subscript operator.
1.600 @@ -2360,9 +2366,9 @@
1.601 const Graph& _graph;
1.602 };
1.603
1.604 - /// \brief Returns a \ref ForwardMap class.
1.605 + /// \brief Returns a \c ForwardMap class.
1.606 ///
1.607 - /// This function just returns an \ref ForwardMap class.
1.608 + /// This function just returns an \c ForwardMap class.
1.609 /// \relates ForwardMap
1.610 template <typename Graph>
1.611 inline ForwardMap<Graph> forwardMap(const Graph& graph) {
1.612 @@ -2383,7 +2389,7 @@
1.613 /// \brief Constructor
1.614 ///
1.615 /// Constructor
1.616 - /// \param _graph The graph that the map belongs to.
1.617 + /// \param graph The graph that the map belongs to.
1.618 explicit BackwardMap(const Graph& graph) : _graph(graph) {}
1.619
1.620 /// \brief The subscript operator.
1.621 @@ -2399,9 +2405,9 @@
1.622 const Graph& _graph;
1.623 };
1.624
1.625 - /// \brief Returns a \ref BackwardMap class
1.626 -
1.627 - /// This function just returns a \ref BackwardMap class.
1.628 + /// \brief Returns a \c BackwardMap class
1.629 +
1.630 + /// This function just returns a \c BackwardMap class.
1.631 /// \relates BackwardMap
1.632 template <typename Graph>
1.633 inline BackwardMap<Graph> backwardMap(const Graph& graph) {