summaryrefslogtreecommitdiffstats
path: root/doc/global/html-config.qdocconf
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2014-06-04 14:44:55 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-06-11 15:13:29 +0200
commite2a7293290b7aa7090c4ce2178e35eccaea11a00 (patch)
tree3bb475936b8fc11faa1b12c45a144ce0b2674b74 /doc/global/html-config.qdocconf
parentde1afe41e3e8abc906d3e4499da61c8b1e4c5bbc (diff)
QDoc: Introduce a variable to set table of contents depth.
-"HTML.tocdepth" variable controls depth value. -setting to "0" disables table of contents. -sections 3 and 4 usually don't have descriptive titles to warrant their listing in the table of contents. -table width and CSS (online and offline) don't support wide entries. -Config class' getInt() function now returns -1 if a variable is not set. -for Qt 5 and projects which use html-config.qdocconf, tocdepth is set to "2". -added variable documentation. Task-number: QTBUG-38967 Change-Id: Ibd612f5b846ecb9c4b575e7ac11605c6efd2b77c Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com> Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com> Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'doc/global/html-config.qdocconf')
-rw-r--r--doc/global/html-config.qdocconf2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/global/html-config.qdocconf b/doc/global/html-config.qdocconf
index 1560db8d98..9b3b05b7d3 100644
--- a/doc/global/html-config.qdocconf
+++ b/doc/global/html-config.qdocconf
@@ -2,6 +2,8 @@
HTML.nonavigationbar = "false"
+HTML.tocdepth = 2
+
HTML.extraimages += template/images/arrow_bc.png \
template/images/home.png \
template/images/ico_out.png \