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/I14_PreprocessorDirectives.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/I14_PreprocessorDirectives.dox')
-rw-r--r-- | doc/I14_PreprocessorDirectives.dox | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/I14_PreprocessorDirectives.dox b/doc/I14_PreprocessorDirectives.dox index 4b5310c60..0c4c47464 100644 --- a/doc/I14_PreprocessorDirectives.dox +++ b/doc/I14_PreprocessorDirectives.dox @@ -7,7 +7,7 @@ should be defined before any %Eigen headers are included. Often they are best se This page lists the preprocesor tokens recognised by %Eigen. -\tableofcontents +\eigenAutoToc \section TopicPreprocessorDirectivesMajor Macros with major effects |