diff options
author | Gael Guennebaud <g.gael@free.fr> | 2013-01-05 16:37:11 +0100 |
---|---|---|
committer | Gael Guennebaud <g.gael@free.fr> | 2013-01-05 16:37:11 +0100 |
commit | 93ee82b1fda6d395d1f70d7fb767b5dceaf4ca29 (patch) | |
tree | 21de49e996afa6db673dcff8757ed7bbbb0bf587 /doc/C10_TutorialMapClass.dox | |
parent | eac676ff6cf3f9c2d4a11e92e7211e7d763e8d6f (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/C10_TutorialMapClass.dox')
-rw-r--r-- | doc/C10_TutorialMapClass.dox | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/C10_TutorialMapClass.dox b/doc/C10_TutorialMapClass.dox index e07b404d1..0d9dc602f 100644 --- a/doc/C10_TutorialMapClass.dox +++ b/doc/C10_TutorialMapClass.dox @@ -1,6 +1,6 @@ namespace Eigen { -/** \page TutorialMapClass Tutorial page 10 - Interfacing with C/C++ arrays and external libraries: the %Map class +/** \eigenManualPage TutorialMapClass Interfacing with C/C++ arrays and external libraries: the %Map class \ingroup Tutorial @@ -9,7 +9,7 @@ namespace Eigen { This tutorial page explains how to work with "raw" C++ arrays. This can be useful in a variety of contexts, particularly when "importing" vectors and matrices from other libraries into Eigen. -\tableofcontents +\eigenAutoToc \section TutorialMapIntroduction Introduction |