diff options
| author |  Christoph Hertzberg <chtz@informatik.uni-bremen.de> | 2015-05-01 22:10:41 +0200 |
|---|---|---|
| committer | Christoph Hertzberg <chtz@informatik.uni-bremen.de> | 2015-05-01 22:10:41 +0200 |
| commit | 28a4c92cbff88c75b932ce0d091ccaa2b6010724 (patch) | |
| tree | 75eb0f8005954c5049f050e45bfcb2d8173c5671 /doc/StlContainers.dox | |
| parent | 173b34e9abd06202d3df8ba07686b874115956b7 (diff) | |
bug #998: Started fixing doxygen warnings
Diffstat (limited to 'doc/StlContainers.dox')
| -rw-r--r-- | doc/StlContainers.dox | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/StlContainers.dox b/doc/StlContainers.dox index d8d0d529c..e0f8714a9 100644 --- a/doc/StlContainers.dox +++ b/doc/StlContainers.dox @@ -4,7 +4,7 @@ namespace Eigen { \eigenAutoToc -\section summary Executive summary +\section StlContainers_summary Executive summary Using STL containers on \ref TopicFixedSizeVectorizable "fixed-size vectorizable Eigen types", or classes having members of such types, requires taking the following two steps: @@ -28,7 +28,7 @@ std::map<int, Eigen::Vector4f, std::less<int>, \endcode Note that the third parameter "std::less<int>" is just the default value, but we have to include it because we want to specify the fourth parameter, which is the allocator type. -\section vector The case of std::vector +\section StlContainers_vector The case of std::vector The situation with std::vector was even worse (explanation below) so we had to specialize it for the Eigen::aligned_allocator type. In practice you \b must use the Eigen::aligned_allocator (not another aligned allocator), \b and \#include <Eigen/StdVector>. |