summaryrefslogtreecommitdiffstats
path: root/src/config.xml
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2021-05-09 18:00:27 (GMT)
committerDimitri van Heesch <doxygen@gmail.com>2021-05-09 18:00:27 (GMT)
commitcd998a7164e30cee896cccd190846b79ebb4355f (patch)
tree36228200640a1cf5e57979b0e755c9d10200d320 /src/config.xml
parent57ef51ac1d1917f46cd36a9f75aa81bc9c4d086d (diff)
downloadDoxygen-cd998a7164e30cee896cccd190846b79ebb4355f.zip
Doxygen-cd998a7164e30cee896cccd190846b79ebb4355f.tar.gz
Doxygen-cd998a7164e30cee896cccd190846b79ebb4355f.tar.bz2
Reintroducing the sidebar layout via new FULL_SIDEBAR option.
- This new page layout is only enabled if DISABLE_INDEX=YES, GENERATE_TREEVIEW=YES, and FULL_SIDEBAR=YES.
Diffstat (limited to 'src/config.xml')
-rw-r--r--src/config.xml34
1 files changed, 26 insertions, 8 deletions
diff --git a/src/config.xml b/src/config.xml
index be890c3..1527601 100644
--- a/src/config.xml
+++ b/src/config.xml
@@ -1914,21 +1914,25 @@ doxygen -w html new_header.html new_footer.html new_stylesheet.css YourConfigFil
The following block names are supported:
<dl>
<dt><code>DISABLE_INDEX</code><dd>Content within this block is copied to the output
- when the \ref cfg_disable_index "DISABLE_INDEX" option is enabled (so when the index is disabled).
+ if the \ref cfg_disable_index "DISABLE_INDEX" option is enabled (so when the index is disabled).
<dt><code>GENERATE_TREEVIEW</code><dd>Content within this block is copied to the output
- when the \ref cfg_generate_treeview "GENERATE_TREEVIEW" option is enabled.
+ if the \ref cfg_generate_treeview "GENERATE_TREEVIEW" option is enabled.
<dt><code>SEARCHENGINE</code><dd>Content within this block is copied to the output
- when the \ref cfg_searchengine "SEARCHENGINE" option is enabled.
+ if the \ref cfg_searchengine "SEARCHENGINE" option is enabled.
<dt><code>PROJECT_NAME</code><dd>Content within the block is copied to the output
- when the \ref cfg_project_name "PROJECT_NAME" option is not empty.
+ if the \ref cfg_project_name "PROJECT_NAME" option is not empty.
<dt><code>PROJECT_NUMBER</code><dd>Content within the block is copied to the output
- when the \ref cfg_project_number "PROJECT_NUMBER" option is not empty.
+ if the \ref cfg_project_number "PROJECT_NUMBER" option is not empty.
<dt><code>PROJECT_BRIEF</code><dd>Content within the block is copied to the output
- when the \ref cfg_project_brief "PROJECT_BRIEF" option is not empty.
+ if the \ref cfg_project_brief "PROJECT_BRIEF" option is not empty.
<dt><code>PROJECT_LOGO</code><dd>Content within the block is copied to the output
- when the \ref cfg_project_logo "PROJECT_LOGO" option is not empty.
+ if the \ref cfg_project_logo "PROJECT_LOGO" option is not empty.
+ <dt><code>FULL_SIDEBAR</code><dd>Content within the block is copied to the output
+ if the \ref cfg_full_sidebar "FULL_SIDEBAR",
+ \ref cfg_disable_index "DISABLE_INDEX" and \ref cfg_generate_treeview "GENERATE_TREEVIEW"
+ options are all enabled.
<dt><code>TITLEAREA</code><dd>Content within this block is copied to the output
- when a title is visible at the top of each page. This is the case
+ if a title is visible at the top of each page. This is the case
if either \ref cfg_project_name "PROJECT_NAME",
\ref cfg_project_brief "PROJECT_BRIEF", \ref cfg_project_logo "PROJECT_LOGO"
is filled in or if both \ref cfg_disable_index "DISABLE_INDEX" and
@@ -2391,7 +2395,21 @@ The \c DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
]]>
</docs>
</option>
+ <option type='bool' id='FULL_SIDEBAR' defval='0' depends='GENERATE_HTML'>
+ <docs>
+<![CDATA[
+ When both \c GENERATE_TREEVIEW and \c DISABLE_INDEX are set to YES, then the
+ \c FULL_SIDEBAR option determines if the side bar is limited to only the
+ treeview area (value \c NO) or if it should extend to the full height of the
+ window (value \c YES). Setting this to \c YES gives a layout similar to
+ https://docs.readthedocs.io with more room for contents,
+ but less room for the project logo, title, and description.
+ If either \c GENERATOR_TREEVIEW or \c DISABLE_INDEX is set to \c NO, this option
+ has no effect.
+]]>
+ </docs>
+ </option>
<option type='int' id='ENUM_VALUES_PER_LINE' minval='0' maxval='20' defval='4' depends='GENERATE_HTML'>
<docs>
<![CDATA[