GitHub-Proxy/eigen
1
0
Fork 0
mirror of https://gitlab.com/libeigen/eigen.git synced 2025-08-12 03:39:01 +08:00
Code Issues Packages Projects Releases Wiki Activity

Escape \# inside doxygen docu

Browse Source
This commit is contained in:
Christoph Hertzberg 2019-07-12 19:45:13 +02:00
parent c2671e5315
commit 9237883ff1
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Pitfalls.dox
View File

@ -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) \section TopicPitfalls_header_issues Header Issues (failure to compile)
With all libraries, one must check the documentation for which header to include. 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: For example, if you want to use the \c cross() method on a vector (it computes a cross-product) then you need to:
\code \code
#include<Eigen/Geometry> #include<Eigen/Geometry>

2
doc/StlContainers.dox
View File

@ -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. 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. %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". 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. For other %Eigen types, such as Vector3f or MatrixXd, no special care is needed when using STL containers.