summaryrefslogtreecommitdiffstats
path: root/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
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')
-rw-r--r--doc/CMakeLists.txt4
-rw-r--r--doc/customize.doc12
-rw-r--r--doc/layout_index_and_notreeview.pngbin0 -> 10472 bytes
-rw-r--r--doc/layout_index_and_treeview.pngbin0 -> 13347 bytes
-rw-r--r--doc/layout_noindex_and_notreeview.pngbin0 -> 8831 bytes
-rw-r--r--doc/layout_noindex_and_treeview.pngbin0 -> 11914 bytes
-rw-r--r--doc/starting.doc38
7 files changed, 33 insertions, 21 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index f7f680f..7dbe120 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -82,6 +82,10 @@ set(DOC_FILES
infoflow.fig
infoflow.png
install.doc
+ layout_index_and_notreeview.png
+ layout_index_and_treeview.png
+ layout_noindex_and_notreeview.png
+ layout_noindex_and_treeview.png
lists.doc
markdown.doc
output.doc
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
diff --git a/doc/layout_index_and_notreeview.png b/doc/layout_index_and_notreeview.png
new file mode 100644
index 0000000..8fecd41
--- /dev/null
+++ b/doc/layout_index_and_notreeview.png
Binary files differ
diff --git a/doc/layout_index_and_treeview.png b/doc/layout_index_and_treeview.png
new file mode 100644
index 0000000..3a652fb
--- /dev/null
+++ b/doc/layout_index_and_treeview.png
Binary files differ
diff --git a/doc/layout_noindex_and_notreeview.png b/doc/layout_noindex_and_notreeview.png
new file mode 100644
index 0000000..72c39a5
--- /dev/null
+++ b/doc/layout_noindex_and_notreeview.png
Binary files differ
diff --git a/doc/layout_noindex_and_treeview.png b/doc/layout_noindex_and_treeview.png
new file mode 100644
index 0000000..f0cd225
--- /dev/null
+++ b/doc/layout_noindex_and_treeview.png
Binary files differ
diff --git a/doc/starting.doc b/doc/starting.doc
index 44f2a92..7e5b404 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -109,27 +109,23 @@ using the following table:
Extension | Language | Extension | Language | Extension | Language
---------:|--------- | ---------:|------------- | ---------:|---------
-.dox |C / C++ | .idl |IDL | .f |Fortran
-.doc |C / C++ | .ddl |IDL | .for |Fortran
-.c |C / C++ | .odl |IDL | .f90 |Fortran
-.cc |C / C++ | .java |Java | .f95 |Fortran
-.cxx |C / C++ | .cs |C# | .f03 |Fortran
-.cpp |C / C++ | .d |D | .f08 |Fortran
-.c++ |C / C++ | .php |PHP | .f18 |Fortran
-.ii |C / C++ | .php4 |PHP | .vhd |VHDL
-.ixx |C / C++ | .php5 |PHP | .vhdl |VHDL
-.ipp |C / C++ | .inc |PHP | .ucf |VHDL
-.i++ |C / C++ | .phtml |PHP | .qsf |VHDL
-.inl |C / C++ | .m |Objective-C | .l |Lex
-.h |C / C++ | .M |Objective-C | .md |Markdown
-.H |C / C++ | .py |Python | .markdown |Markdown
-.hh |C / C++ | .pyw |Python | .ice |Slice
-.HH |C / C++ | | | | |
-.hxx |C / C++ | | | | |
-.hpp |C / C++ | | | | |
-.h++ |C / C++ | | | | |
-.mm |C / C++ | | | | |
-.txt |C / C++ | | | | |
+.dox |C / C++ | .hpp |C / C++ |.py |Python
+.doc |C / C++ | .h++ |C / C++ |.pyw |Python
+.c |C / C++ | .mm |C / C++ |.f |Fortran
+.cc |C / C++ | .txt |C / C++ |.for |Fortran
+.cxx |C / C++ | .idl |IDL |.f90 |Fortran
+.cpp |C / C++ | .ddl |IDL |.f95 |Fortran
+.c++ |C / C++ | .odl |IDL |.f03 |Fortran
+.ii |C / C++ | .java |Java |.f08 |Fortran
+.ixx |C / C++ | .cs |C# |.f18 |Fortran
+.ipp |C / C++ | .d |D |.vhd |VHDL
+.i++ |C / C++ | .php |PHP |.vhdl |VHDL
+.inl |C / C++ | .php4 |PHP |.ucf |VHDL
+.h |C / C++ | .php5 |PHP |.qsf |VHDL
+.H |C / C++ | .inc |PHP |.l |Lex
+.hh |C / C++ | .phtml |PHP |.md |Markdown
+.HH |C / C++ | .m |Objective-C |.markdown |Markdown
+.hxx |C / C++ | .M |Objective-C |.ice |Slice
Please note that the above list might contain more items than that by default set
in the \ref cfg_file_patterns "FILE_PATTERNS".