Doc: split customizing-eigen page into sub-pages and re-structure a bit the different topics

This commit is contained in:
Gael Guennebaud
2016-08-30 11:10:08 +02:00
parent cffe8bbff7
commit 9c9e23858e
17 changed files with 248 additions and 235 deletions

View File

@@ -3,22 +3,30 @@
namespace Eigen {
/** \page UserManual_CustomizingEigen Extending/Customizing Eigen
%Eigen can be extended in several ways, for instance, by defining global methods, by inserting custom methods within main %Eigen's classes through the \ref TopicCustomizing_Plugins "plugin" mechanism, by adding support to \ref TopicCustomizing_CustomScalar "custom scalar types" etc. See below for the respective sub-topics.
- \subpage TopicCustomizing_Plugins
- \subpage TopicCustomizing_InheritingMatrix
- \subpage TopicCustomizing_CustomScalar
- \subpage TopicNewExpressionType
\sa \ref TopicPreprocessorDirectives
*/
/** \page UserManual_Generalities General topics
- \subpage Eigen2ToEigen3
- \subpage TopicFunctionTakingEigenTypes
- \subpage TopicPreprocessorDirectives
- \subpage TopicAssertions
- \subpage TopicCustomizingEigen
- \subpage TopicMultiThreading
- \subpage TopicUsingBlasLapack
- \subpage TopicUsingIntelMKL
- \subpage TopicCUDA
- \subpage TopicPitfalls
- \subpage TopicTemplateKeyword
- \subpage TopicNewExpressionType
- \subpage UserManual_UnderstandingEigen
*/
/** \page UserManual_UnderstandingEigen Understanding Eigen
- \subpage TopicInsideEigenExample
- \subpage TopicClassHierarchy