summaryrefslogtreecommitdiffstats
path: root/doc/customize.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2021-05-08 14:36:12 (GMT)
committerDimitri van Heesch <doxygen@gmail.com>2021-05-08 14:36:12 (GMT)
commit12a6d876e3ff0004e288f1c7fadb10d0431bfc24 (patch)
treecb8cec1ebb755d6e0a4a44dfa35ce01b141a8f18 /doc/customize.doc
parent99f9fc74eda25616f3d5c3e40f030c8c7ecce4bb (diff)
downloadDoxygen-12a6d876e3ff0004e288f1c7fadb10d0431bfc24.zip
Doxygen-12a6d876e3ff0004e288f1c7fadb10d0431bfc24.tar.gz
Doxygen-12a6d876e3ff0004e288f1c7fadb10d0431bfc24.tar.bz2
Optimized the layout in case DISABLE_INDEX=YES and GENERATE_TREEVIEW=YES
- also illustrated the various layouts in the customization section of the manual to make choosing easier.
Diffstat (limited to 'doc/customize.doc')
-rw-r--r--doc/customize.doc12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/customize.doc b/doc/customize.doc
index eebeb5c..c95c4c2 100644
--- a/doc/customize.doc
+++ b/doc/customize.doc
@@ -52,16 +52,25 @@ corresponding with the following settings:
- \ref cfg_disable_index "DISABLE_INDEX" = \c NO
- \ref cfg_generate_treeview "GENERATE_TREEVIEW" = \c NO
+\image html layout_index_and_notreeview.png
+\image latex layout_index_and_notreeview.png width=8cm
+
you can switch to an interactive navigation tree as sidebar using
- \ref cfg_disable_index "DISABLE_INDEX" = \c YES
- \ref cfg_generate_treeview "GENERATE_TREEVIEW" = \c YES
+\image html layout_noindex_and_treeview.png
+\image latex layout_noindex_and_treeview.png width=8cm
+
or even have both forms of navigation:
- \ref cfg_disable_index "DISABLE_INDEX" = \c NO
- \ref cfg_generate_treeview "GENERATE_TREEVIEW" = \c YES
+\image html layout_index_and_treeview.png
+\image latex layout_index_and_treeview.png width=8cm
+
if you already use an external index (i.e. have one of the following
options enabled
\ref cfg_generate_htmlhelp "GENERATE_HTMLHELP",
@@ -73,6 +82,9 @@ then you can also disable all indices, like so:
- \ref cfg_disable_index "DISABLE_INDEX" = \c YES
- \ref cfg_generate_treeview "GENERATE_TREEVIEW" = \c NO
+\image html layout_noindex_and_notreeview.png
+\image latex layout_noindex_and_notreeview.png width=8cm
+
\subsection minor_tweaks_dynsection Dynamic Content
To make the HTML output more interactive, doxygen provides a number of options