mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-03-01 18:26:24 +08:00
93ee82b1fd
- Organize the documentation into "chapters". - Each chapter include many documentation pages, reference pages organized as modules, and a quick reference page. - The "Chapters" tree is created using the defgroup/ingroup mechanism, even for the documentation pages (i.e., .dox files for which I added an \eigenManualPage macro that we can switch between \page or \defgroup ). - Add a "General topics" entry for all pages that do not fit well in the previous "chapters". - The highlevel struture is managed by a new eigendoxy_layout.xml file. - remove the "index" and quite useless pages (namespace list, class hierarchy, member list, file list, etc.) - add the javascript search-engine. - add the "treeview" panel. - remove \tableofcontents (replace them by a custom \eigenAutoToc macro to be able to easily re-enable if needed). - add javascript to automatically generate a TOC from the h1/h2 tags of the current page, and put the TOC in the left side panel. - overload various javascript function generated by doxygen to: - remove the root of the treeview - remove links to section/subsection from the treeview - automatically expand the "Chapters" section - automatically expand the current section - adjust the height of the treeview to take into account the TOC - always use the default .css file, eigendoxy.css now only includes our modifications - use Doxyfile to specify our logo - remove cross references to unsupported modules (temporarily) |
||
|---|---|---|
| .. | ||
| examples | ||
| snippets | ||
| special_examples | ||
| A05_PortingFrom2To3.dox | ||
| A10_Eigen2SupportModes.dox | ||
| AsciiQuickReference.txt | ||
| B01_Experimental.dox | ||
| C00_QuickStartGuide.dox | ||
| C01_TutorialMatrixClass.dox | ||
| C02_TutorialMatrixArithmetic.dox | ||
| C03_TutorialArrayClass.dox | ||
| C04_TutorialBlockOperations.dox | ||
| C05_TutorialAdvancedInitialization.dox | ||
| C06_TutorialLinearAlgebra.dox | ||
| C07_TutorialReductionsVisitorsBroadcasting.dox | ||
| C08_TutorialGeometry.dox | ||
| C09_TutorialSparse.dox | ||
| C10_TutorialMapClass.dox | ||
| CMakeLists.txt | ||
| D01_StlContainers.dox | ||
| D03_WrongStackAlignment.dox | ||
| D07_PassingByValue.dox | ||
| D09_StructHavingEigenMembers.dox | ||
| D11_UnalignedArrayAssert.dox | ||
| Doxyfile.in | ||
| eigen_navtree_hacks.js | ||
| Eigen_Silly_Professor_64x64.png | ||
| eigendoxy_footer.html.in | ||
| eigendoxy_header.html.in | ||
| eigendoxy_layout.xml.in | ||
| eigendoxy_tabs.css | ||
| eigendoxy.css | ||
| I00_CustomizingEigen.dox | ||
| I01_TopicLazyEvaluation.dox | ||
| I02_HiPerformance.dox | ||
| I03_InsideEigenExample.dox | ||
| I05_FixedSizeVectorizable.dox | ||
| I06_TopicEigenExpressionTemplates.dox | ||
| I07_TopicScalarTypes.dox | ||
| I08_Resizing.dox | ||
| I09_Vectorization.dox | ||
| I10_Assertions.dox | ||
| I11_Aliasing.dox | ||
| I12_ClassHierarchy.dox | ||
| I13_FunctionsTakingEigenTypes.dox | ||
| I14_PreprocessorDirectives.dox | ||
| I15_StorageOrders.dox | ||
| I16_TemplateKeyword.dox | ||
| I17_SparseLinearSystems.dox | ||
| Manual.dox | ||
| Overview.dox | ||
| QuickReference.dox | ||
| SparseQuickReference.dox | ||
| TopicLinearAlgebraDecompositions.dox | ||
| TopicMultithreading.dox | ||
| tutorial.cpp | ||
| TutorialSparse_example_details.dox | ||
| UsingIntelMKL.dox | ||
