aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorGravatar Christoph Hertzberg <chtz@informatik.uni-bremen.de>2019-07-12 19:45:13 +0200
committerGravatar Christoph Hertzberg <chtz@informatik.uni-bremen.de>2019-07-12 19:45:13 +0200
commit9237883ff1602a86471428323a25bc896288e021 (patch)
tree7c1b360e68781dbe61711541cbf842c3dffb438b /doc
parentc2671e53158ed36776bd4003473d525c98a58afa (diff)
Escape \# inside doxygen docu
Diffstat (limited to 'doc')
-rw-r--r--doc/Pitfalls.dox2
-rw-r--r--doc/StlContainers.dox2
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/Pitfalls.dox b/doc/Pitfalls.dox
index fda402572..7ece81ba4 100644
--- a/doc/Pitfalls.dox
+++ b/doc/Pitfalls.dox
@@ -72,7 +72,7 @@ Note that DenseBase::eval() is smart enough to avoid copies when the underlying
\section TopicPitfalls_header_issues Header Issues (failure to compile)
With all libraries, one must check the documentation for which header to include.
-The same is true with %Eigen, but slightly worse: with %Eigen, a method in a class may require an additional <code>#include</code> over what the class itself requires!
+The same is true with %Eigen, but slightly worse: with %Eigen, a method in a class may require an additional \c \#include over what the class itself requires!
For example, if you want to use the \c cross() method on a vector (it computes a cross-product) then you need to:
\code
#include<Eigen/Geometry>
diff --git a/doc/StlContainers.dox b/doc/StlContainers.dox
index 665a54793..0342573d0 100644
--- a/doc/StlContainers.dox
+++ b/doc/StlContainers.dox
@@ -12,7 +12,7 @@ Otherwise, using STL containers on \ref TopicFixedSizeVectorizable "fixed-size v
That is, an allocator capable of allocating buffers with 16, 32, or even 64 bytes alignment.
%Eigen does provide one ready for use: aligned_allocator.
-Prior to \cpp11, if you want to use the `std::vector` container, then you also have to `#include <Eigen/StdVector>`.
+Prior to \cpp11, if you want to use the `std::vector` container, then you also have to <code> \#include <Eigen/StdVector> </code>.
These issues arise only with \ref TopicFixedSizeVectorizable "fixed-size vectorizable Eigen types" and \ref TopicStructHavingEigenMembers "structures having such Eigen objects as member".
For other %Eigen types, such as Vector3f or MatrixXd, no special care is needed when using STL containers.