From ec0b2f900c8850799cf803ab6e0ee64f101e8e9a Mon Sep 17 00:00:00 2001 From: Gael Guennebaud Date: Tue, 13 Jan 2009 08:30:17 +0000 Subject: fix a couple of doxygen issues --- doc/Doxyfile.in | 2 +- doc/QuickStartGuide.dox | 2 +- doc/StlContainers.dox | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index a781d39d1..a10c27f53 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -207,7 +207,7 @@ ALIASES = "only_for_vectors=This is only for vectors (either row- "regression_module=This is defined in the %Regression module. \code #include \endcode" \ "addexample=\anchor" \ "label=\bug" \ - "redstar=*" \ + "redstar=*" \ "nonstableyet=\warning This class/function is not considered to be part of the stable public API yet. Some (minor) changes might happen in future releases." # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C diff --git a/doc/QuickStartGuide.dox b/doc/QuickStartGuide.dox index 446bade0c..9adc95367 100644 --- a/doc/QuickStartGuide.dox +++ b/doc/QuickStartGuide.dox @@ -40,7 +40,7 @@ There is no library to link to. For good performance, add the \c -O2 compile-fla On the x86 architecture, the SSE2 instruction set is not enabled by default. Use \c -msse2 to enable it, and Eigen will then automatically enable its vectorized paths. On x86-64 and AltiVec-based architectures, vectorization is enabled by default. - + \warning \redstar In most cases it is enough to include the \c Eigen/Core header only to get started with Eigen. However, some features presented in this tutorial require the Array module to be included (\c \#include \c ). Those features are highlighted with a red star \redstar. \section TutorialCoreSimpleExampleFixedSize Simple example with fixed-size matrices and vectors diff --git a/doc/StlContainers.dox b/doc/StlContainers.dox index 433ae8a72..f51ed6fd2 100644 --- a/doc/StlContainers.dox +++ b/doc/StlContainers.dox @@ -12,7 +12,7 @@ namespace Eigen { Using STL containers on \ref FixedSizeVectorizable "fixed-size vectorizable Eigen types" requires taking the following two steps: \li A 16-byte-aligned allocator must be used. Eigen does provide one ready for use: aligned_allocator. -\li If you want to use the std::vector container, you need to #include . +\li If you want to use the std::vector container, you need to \#include . These issues arise only with \ref FixedSizeVectorizable "fixed-size vectorizable Eigen types". For other Eigen types, such as Vector3f or MatrixXd, no special care is needed when using STL containers. @@ -32,7 +32,7 @@ Note that here, the 3rd parameter "std::less" is just the default value, we \section vector The case of std::vector -The situation with std::vector was even worse (explanation below) so we had to specialize it for Eigen types. The upside is that our specialization takes care of specifying the aligned allocator, so you don't need to worry about it. All you need to do is to #include . +The situation with std::vector was even worse (explanation below) so we had to specialize it for Eigen types. The upside is that our specialization takes care of specifying the aligned allocator, so you don't need to worry about it. All you need to do is to \#include . So as soon as you have \code -- cgit v1.2.3