aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2013-07-02 14:08:12 +0100
committerGravatar Jitse Niesen <jitse@maths.leeds.ac.uk>2013-07-02 14:08:12 +0100
commit4e458d309c843dbeb91505a2c75f75494512ed47 (patch)
tree33e61c9d0fd681e55a115a26a17df9b22cf4cad5 /doc
parent419b5cff44a6d2cdd3872a809f9dfdfa283f0dc3 (diff)
Fix some doxygen errors and warnings.
Diffstat (limited to 'doc')
-rw-r--r--doc/A05_PortingFrom2To3.dox2
-rw-r--r--doc/Manual.dox2
-rw-r--r--doc/TutorialSparse.dox4
-rw-r--r--doc/snippets/Cwise_asin.cpp2
4 files changed, 7 insertions, 3 deletions
diff --git a/doc/A05_PortingFrom2To3.dox b/doc/A05_PortingFrom2To3.dox
index 3750316c5..d885b4f6d 100644
--- a/doc/A05_PortingFrom2To3.dox
+++ b/doc/A05_PortingFrom2To3.dox
@@ -281,7 +281,7 @@ result = Vector4f::MapAligned(some_aligned_array);
\section StdContainers STL Containers
-In Eigen2, #include<Eigen/StdVector> tweaked std::vector to automatically align elements. The problem was that that was quite invasive. In Eigen3, we only override standard behavior if you use Eigen::aligned_allocator<T> as your allocator type. So for example, if you use std::vector<Matrix4f>, you need to do the following change (note that aligned_allocator is under namespace Eigen):
+In Eigen2, <tt>#include<Eigen/StdVector></tt> tweaked std::vector to automatically align elements. The problem was that that was quite invasive. In Eigen3, we only override standard behavior if you use Eigen::aligned_allocator<T> as your allocator type. So for example, if you use std::vector<Matrix4f>, you need to do the following change (note that aligned_allocator is under namespace Eigen):
<table class="manual">
<tr><th>Eigen 2</th><th>Eigen 3</th></tr>
diff --git a/doc/Manual.dox b/doc/Manual.dox
index d6b9f7adf..3367982ca 100644
--- a/doc/Manual.dox
+++ b/doc/Manual.dox
@@ -135,6 +135,8 @@ namespace Eigen {
\ingroup Sparse_Reference */
/** \addtogroup IterativeLinearSolvers_Module
\ingroup Sparse_Reference */
+/** \addtogroup Sparse_Module
+ \ingroup Sparse_Reference */
/** \addtogroup Support_modules
\ingroup Sparse_Reference */
diff --git a/doc/TutorialSparse.dox b/doc/TutorialSparse.dox
index 065edbf69..41bae6b5c 100644
--- a/doc/TutorialSparse.dox
+++ b/doc/TutorialSparse.dox
@@ -2,7 +2,7 @@ namespace Eigen {
/** \eigenManualPage TutorialSparse Sparse matrix manipulations
-\eigeneigenAutoToc
+\eigenAutoToc
Manipulating and solving sparse problems involves various modules which are summarized below:
@@ -14,7 +14,7 @@ Manipulating and solving sparse problems involves various modules which are summ
<td>%Sparse LU factorization to solve general square sparse systems</td></tr>
<tr><td>\link SparseQR_Module SparseQR \endlink</td><td>\code #include<Eigen/SparseQR>\endcode </td><td>%Sparse QR factorization for solving sparse linear least-squares problems</td></tr>
<tr><td>\link IterativeLinearSolvers_Module IterativeLinearSolvers \endlink</td><td>\code#include <Eigen/IterativeLinearSolvers>\endcode</td><td>Iterative solvers to solve large general linear square problems (including self-adjoint positive definite problems)</td></tr>
-<tr><td>\link Sparse_modules Sparse \endlink</td><td>\code#include <Eigen/Sparse>\endcode</td><td>Includes all the above modules</td></tr>
+<tr><td>\link Sparse_Module Sparse \endlink</td><td>\code#include <Eigen/Sparse>\endcode</td><td>Includes all the above modules</td></tr>
</table>
\section TutorialSparseIntro Sparse matrix format
diff --git a/doc/snippets/Cwise_asin.cpp b/doc/snippets/Cwise_asin.cpp
new file mode 100644
index 000000000..8dad838fd
--- /dev/null
+++ b/doc/snippets/Cwise_asin.cpp
@@ -0,0 +1,2 @@
+Array3d v(0, sqrt(2.)/2, 1);
+cout << v.asin() << endl;