diff options
author | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-05-03 17:08:14 +0100 |
---|---|---|
committer | Jitse Niesen <jitse@maths.leeds.ac.uk> | 2011-05-03 17:08:14 +0100 |
commit | a96c849c20cd787c40c2cbf30a496fed7bf2bf1e (patch) | |
tree | afb8853eb08908695e45b3d9ed237557ae2ac571 /doc | |
parent | 1947da39ab18813ac5611f81c034eaca3ddc98a5 (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 'doc')
-rw-r--r-- | doc/A05_PortingFrom2To3.dox | 2 | ||||
-rw-r--r-- | doc/Doxyfile.in | 2 | ||||
-rw-r--r-- | doc/I03_InsideEigenExample.dox | 4 | ||||
-rw-r--r-- | doc/QuickReference.dox | 2 |
4 files changed, 5 insertions, 5 deletions
diff --git a/doc/A05_PortingFrom2To3.dox b/doc/A05_PortingFrom2To3.dox index 4167dfe33..10ce96870 100644 --- a/doc/A05_PortingFrom2To3.dox +++ b/doc/A05_PortingFrom2To3.dox @@ -287,7 +287,7 @@ The EIGEN_DONT_ALIGN option still exists in Eigen 3, but it has a new cousin: EI A common issue with Eigen 2 was that when mapping an array with Map, there was no way to tell Eigen that your array was aligned. There was a ForceAligned option but it didn't mean that; it was just confusing and has been removed. -New in Eigen3 is the Aligned option. See the documentation of class Map. Use it like this: +New in Eigen3 is the #Aligned option. See the documentation of class Map. Use it like this: \code Map<Vector4f, Aligned> myMappedVector(some_aligned_array); \endcode diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index d9f5f6d91..6a659d9c2 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -488,7 +488,7 @@ SHOW_FILES = YES # Namespaces page. This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. -SHOW_NAMESPACES = NO +SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from diff --git a/doc/I03_InsideEigenExample.dox b/doc/I03_InsideEigenExample.dox index 0c60984a2..3245a01c0 100644 --- a/doc/I03_InsideEigenExample.dox +++ b/doc/I03_InsideEigenExample.dox @@ -400,7 +400,7 @@ inline void writePacket(int index, const PacketScalar& x) internal::pstoret<Scalar, PacketScalar, StoreMode>(m_storage.data() + index, x); } \endcode -Here, \a StoreMode is \a Aligned, indicating that we are doing a 128-bit-aligned write access, \a PacketScalar is a type representing a "SSE packet of 4 floats" and internal::pstoret is a function writing such a packet in memory. Their definitions are architecture-specific, we find them in src/Core/arch/SSE/PacketMath.h: +Here, \a StoreMode is \a #Aligned, indicating that we are doing a 128-bit-aligned write access, \a PacketScalar is a type representing a "SSE packet of 4 floats" and internal::pstoret is a function writing such a packet in memory. Their definitions are architecture-specific, we find them in src/Core/arch/SSE/PacketMath.h: The line in src/Core/arch/SSE/PacketMath.h that determines the PacketScalar type (via a typedef in Matrix.h) is: \code @@ -442,7 +442,7 @@ class CwiseBinaryOp } }; \endcode -Here, \a m_lhs is the vector \a v, and \a m_rhs is the vector \a w. So the packet() function here is Matrix::packet(). The template parameter \a LoadMode is \a Aligned. So we're looking at +Here, \a m_lhs is the vector \a v, and \a m_rhs is the vector \a w. So the packet() function here is Matrix::packet(). The template parameter \a LoadMode is \a #Aligned. So we're looking at \code class Matrix { diff --git a/doc/QuickReference.dox b/doc/QuickReference.dox index 496dadb62..a578d15a6 100644 --- a/doc/QuickReference.dox +++ b/doc/QuickReference.dox @@ -594,7 +594,7 @@ unit or null diagonal (read/write): </td><td>\code m.triangularView<Xxx>() \endcode \n -\c Xxx = Upper, Lower, StrictlyUpper, StrictlyLower, UnitUpper, UnitLower +\c Xxx = ::Upper, ::Lower, ::StrictlyUpper, ::StrictlyLower, ::UnitUpper, ::UnitLower </td></tr> <tr><td> Writing to a specific triangular part:\n (only the referenced triangular part is evaluated) |