mirror of
https://gitlab.com/libeigen/eigen.git
synced 2025-10-14 00:51:28 +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)
178 lines
5.1 KiB
XML
178 lines
5.1 KiB
XML
<?xml version="1.0"?>
|
|
<doxygenlayout version="1.0">
|
|
<!-- Navigation index tabs for HTML output -->
|
|
<navindex>
|
|
<tab type="user" url="index.html" title="Overview" />
|
|
<tab type="user" url="@ref GettingStarted" title="Getting started" />
|
|
<tab type="modules" visible="yes" title="Chapters" intro=""/>
|
|
<tab type="mainpage" visible="yes" title=""/>
|
|
<tab type="classlist" visible="yes" title="" intro=""/>
|
|
</navindex>
|
|
|
|
<!-- Layout definition for a class page -->
|
|
<class>
|
|
<briefdescription visible="no"/>
|
|
<includes visible="$SHOW_INCLUDE_FILES"/>
|
|
<detaileddescription title=""/>
|
|
<inheritancegraph visible="$CLASS_GRAPH"/>
|
|
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
|
<allmemberslink visible="yes"/>
|
|
<memberdecl>
|
|
<nestedclasses visible="yes" title=""/>
|
|
<publictypes title=""/>
|
|
<publicslots title=""/>
|
|
<signals title=""/>
|
|
<publicmethods title=""/>
|
|
<publicstaticmethods title=""/>
|
|
<publicattributes title=""/>
|
|
<publicstaticattributes title=""/>
|
|
<protectedtypes title=""/>
|
|
<protectedslots title=""/>
|
|
<protectedmethods title=""/>
|
|
<protectedstaticmethods title=""/>
|
|
<protectedattributes title=""/>
|
|
<protectedstaticattributes title=""/>
|
|
<packagetypes title=""/>
|
|
<packagemethods title=""/>
|
|
<packagestaticmethods title=""/>
|
|
<packageattributes title=""/>
|
|
<packagestaticattributes title=""/>
|
|
<properties title=""/>
|
|
<events title=""/>
|
|
<privatetypes title=""/>
|
|
<privateslots title=""/>
|
|
<privatemethods title=""/>
|
|
<privatestaticmethods title=""/>
|
|
<privateattributes title=""/>
|
|
<privatestaticattributes title=""/>
|
|
<friends title=""/>
|
|
<related title="" subtitle=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<constructors title=""/>
|
|
<functions title=""/>
|
|
<related title=""/>
|
|
<variables title=""/>
|
|
<properties title=""/>
|
|
<events title=""/>
|
|
</memberdef>
|
|
<usedfiles visible="$SHOW_USED_FILES"/>
|
|
<authorsection visible="yes"/>
|
|
</class>
|
|
|
|
<!-- Layout definition for a namespace page -->
|
|
<namespace>
|
|
<briefdescription visible="yes"/>
|
|
<memberdecl>
|
|
<nestednamespaces visible="yes" title=""/>
|
|
<classes visible="yes" title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
</memberdef>
|
|
<authorsection visible="yes"/>
|
|
</namespace>
|
|
|
|
<!-- Layout definition for a file page -->
|
|
<file>
|
|
<briefdescription visible="yes"/>
|
|
<includes visible="$SHOW_INCLUDE_FILES"/>
|
|
<includegraph visible="$INCLUDE_GRAPH"/>
|
|
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
|
<sourcelink visible="yes"/>
|
|
<memberdecl>
|
|
<classes visible="yes" title=""/>
|
|
<namespaces visible="yes" title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
<memberdef>
|
|
<inlineclasses title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
</memberdef>
|
|
<authorsection/>
|
|
</file>
|
|
|
|
<!-- Layout definition for a group page -->
|
|
<group>
|
|
<briefdescription visible="no"/>
|
|
<detaileddescription title=""/>
|
|
<groupgraph visible="$GROUP_GRAPHS"/>
|
|
<memberdecl>
|
|
<nestedgroups visible="yes" title=""/>
|
|
<dirs visible="yes" title=""/>
|
|
<files visible="yes" title=""/>
|
|
<namespaces visible="yes" title=""/>
|
|
<classes visible="yes" title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<enumvalues title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<signals title=""/>
|
|
<publicslots title=""/>
|
|
<protectedslots title=""/>
|
|
<privateslots title=""/>
|
|
<events title=""/>
|
|
<properties title=""/>
|
|
<friends title=""/>
|
|
<membergroups visible="yes"/>
|
|
</memberdecl>
|
|
|
|
<memberdef>
|
|
<pagedocs/>
|
|
<inlineclasses title=""/>
|
|
<defines title=""/>
|
|
<typedefs title=""/>
|
|
<enums title=""/>
|
|
<enumvalues title=""/>
|
|
<functions title=""/>
|
|
<variables title=""/>
|
|
<signals title=""/>
|
|
<publicslots title=""/>
|
|
<protectedslots title=""/>
|
|
<privateslots title=""/>
|
|
<events title=""/>
|
|
<properties title=""/>
|
|
<friends title=""/>
|
|
</memberdef>
|
|
<authorsection visible="yes"/>
|
|
</group>
|
|
|
|
<!-- Layout definition for a directory page -->
|
|
<directory>
|
|
<briefdescription visible="yes"/>
|
|
<directorygraph visible="yes"/>
|
|
<memberdecl>
|
|
<dirs visible="yes"/>
|
|
<files visible="yes"/>
|
|
</memberdecl>
|
|
<detaileddescription title=""/>
|
|
</directory>
|
|
</doxygenlayout>
|