From 9237883ff1602a86471428323a25bc896288e021 Mon Sep 17 00:00:00 2001 From: Christoph Hertzberg Date: Fri, 12 Jul 2019 19:45:13 +0200 Subject: Escape \# inside doxygen docu --- doc/Pitfalls.dox | 2 +- doc/StlContainers.dox | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') 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 #include 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 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 `. +Prior to \cpp11, if you want to use the `std::vector` container, then you also have to \#include . 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. -- cgit v1.2.3