aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Overview.dox
diff options
context:
space:
mode:
authorGravatar Gael Guennebaud <g.gael@free.fr>2013-01-05 16:37:11 +0100
committerGravatar Gael Guennebaud <g.gael@free.fr>2013-01-05 16:37:11 +0100
commit93ee82b1fda6d395d1f70d7fb767b5dceaf4ca29 (patch)
tree21de49e996afa6db673dcff8757ed7bbbb0bf587 /doc/Overview.dox
parenteac676ff6cf3f9c2d4a11e92e7211e7d763e8d6f (diff)
Big changes in Eigen documentation:
- 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)
Diffstat (limited to 'doc/Overview.dox')
-rw-r--r--doc/Overview.dox6
1 files changed, 2 insertions, 4 deletions
diff --git a/doc/Overview.dox b/doc/Overview.dox
index 2657c85bc..0b08f851a 100644
--- a/doc/Overview.dox
+++ b/doc/Overview.dox
@@ -1,6 +1,6 @@
namespace Eigen {
-o /** \mainpage Eigen
+/** \mainpage notitle
<div class="eimainmenu">
\ref GettingStarted "Getting started"
@@ -29,7 +29,7 @@ For a first contact with Eigen, the best place is to have a look at the \ref Get
- \ref TutorialSparse
- \ref TutorialMapClass
- \ref QuickRefPage
- - <b>Advanced topics</b>
+ - \subpage UserManual_Generalities
- \ref TopicAliasing
- \ref TopicLazyEvaluation
- \ref TopicLinearAlgebraDecompositions
@@ -50,8 +50,6 @@ For a first contact with Eigen, the best place is to have a look at the \ref Get
- \ref TopicStructHavingEigenMembers
- \ref TopicPassingByValue
- \ref TopicWrongStackAlignment
-
-
Want more? Checkout the \ref Unsupported_modules "unsupported modules" <a href="unsupported/index.html">documentation</a>.