Changeset 2476:059dcdda37c5 in lemon-0.x for doc/maps1.dox

Timestamp:

09/27/07 15:04:06 (17 years ago)

Author:

Peter Kovacs

Branch:

default

Phase:

public

Convert:

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

Message:

Bug fixes in the documentation (mainly bad references).

File:

• doc/maps1.dox (modified) (4 diffs)

doc/maps1.dox

@@ -16 +16 @@
  *
  */
+
+namespace lemon {
 
 /**
@@ -35 +37 @@
 To make easy to use them - especially as template parameters - there are <i>map concepts</i> like by graph classes.
 <ul>
-<li>\ref ReadMap - values can be read out with the \c operator[].
+<li>\ref concepts::ReadMap "ReadMap" - values can be read out with the \c operator[].
 \code value_typed_variable = map_instance[key_value]; \endcode
 </li>
-<li>\ref WriteMap - values can be set with the \c set() member function.
+<li>\ref concepts::WriteMap "WriteMap" - values can be set with the \c set() member function.
 \code map_instance.set(key_value, value_typed_expression); \endcode
 </li>
-<li>\ref ReadWriteMap - it's just a shortcut to indicate that the map is both
+<li>\ref concepts::ReadWriteMap "ReadWriteMap" - it's just a shortcut to indicate that the map is both
 readable and writable. It is delivered from them.
 </li>
-<li>\ref ReferenceMap - a subclass of ReadWriteMap. It has two additional typedefs
+<li>\ref concepts::ReferenceMap "ReferenceMap" - a subclass of ReadWriteMap. It has two additional typedefs
 <i>Reference</i> and <i>ConstReference</i> and two overloads of \c operator[] to
 providing you constant or non-constant reference to the value belonging to a key,
@@ -50 +52 @@
 </li>
 <li>And there are the Matrix version of these maps, where the values are assigned to a pair of keys.
-The keys can be different types. (\ref ReadMatrixMap, \ref WriteMatrixMap, \ref ReadWriteMatrixMap, \ref ReferenceMatrixMap)
+The keys can be different types. (\ref concepts::ReadMatrixMap "ReadMatrixMap", 
+\ref concepts::WriteMatrixMap "WriteMatrixMap", \ref concepts::ReadWriteMatrixMap "ReadWriteMatrixMap",
+\ref concepts::ReferenceMatrixMap "ReferenceMatrixMap")
 </li>
 </ul>
@@ -89 +93 @@
 Or if you want to know more about maps read these \ref maps2 "advanced map techniques".
 */
+
+}