aboutsummaryrefslogtreecommitdiffhomepage
path: root/Eigen/src/Core/Map.h
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2011-05-03 17:08:14 +0100
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2011-05-03 17:08:14 +0100
commita96c849c20cd787c40c2cbf30a496fed7bf2bf1e (patch)
treeafb8853eb08908695e45b3d9ed237557ae2ac571 /Eigen/src/Core/Map.h
parent1947da39ab18813ac5611f81c034eaca3ddc98a5 (diff)
Document enums in Constants.h (bug #248).
To get the links to work, I also had to document the Eigen namespace. Unfortunately, this means that the word Eigen is linked whenever it appears in the docs.
Diffstat (limited to 'Eigen/src/Core/Map.h')
-rw-r--r--Eigen/src/Core/Map.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/Eigen/src/Core/Map.h b/Eigen/src/Core/Map.h
index 692d0a179..81e3979f3 100644
--- a/Eigen/src/Core/Map.h
+++ b/Eigen/src/Core/Map.h
@@ -31,10 +31,10 @@
*
* \brief A matrix or vector expression mapping an existing array of data.
*
- * \param PlainObjectType the equivalent matrix type of the mapped data
- * \param MapOptions specifies whether the pointer is \c Aligned, or \c Unaligned.
- * The default is \c Unaligned.
- * \param StrideType optionnally specifies strides. By default, Map assumes the memory layout
+ * \tparam PlainObjectType the equivalent matrix type of the mapped data
+ * \tparam MapOptions specifies whether the pointer is \c #Aligned, or \c #Unaligned.
+ * The default is \c #Unaligned.
+ * \tparam StrideType optionnally specifies strides. By default, Map assumes the memory layout
* of an ordinary, contiguous array. This can be overridden by specifying strides.
* The type passed here must be a specialization of the Stride template, see examples below.
*