diff options
author | Jerome Pasion <jerome.pasion@digia.com> | 2014-06-04 14:44:55 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-06-11 15:13:29 +0200 |
commit | e2a7293290b7aa7090c4ce2178e35eccaea11a00 (patch) | |
tree | 3bb475936b8fc11faa1b12c45a144ce0b2674b74 /src/tools/qdoc/htmlgenerator.h | |
parent | de1afe41e3e8abc906d3e4499da61c8b1e4c5bbc (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 'src/tools/qdoc/htmlgenerator.h')
-rw-r--r-- | src/tools/qdoc/htmlgenerator.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/tools/qdoc/htmlgenerator.h b/src/tools/qdoc/htmlgenerator.h index 395ccdb8bf..787b34daf2 100644 --- a/src/tools/qdoc/htmlgenerator.h +++ b/src/tools/qdoc/htmlgenerator.h @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). ** Contact: http://www.qt-project.org/legal ** ** This file is part of the tools applications of the Qt Toolkit. @@ -265,6 +265,7 @@ private: QString qmltypespage; QString buildversion; QString qflagsHref_; + int tocDepth; public: static bool debugging_on; @@ -278,6 +279,7 @@ public: #define HTMLGENERATOR_POSTPOSTHEADER "postpostheader" #define HTMLGENERATOR_NONAVIGATIONBAR "nonavigationbar" #define HTMLGENERATOR_NOSUBDIRS "nosubdirs" +#define HTMLGENERATOR_TOCDEPTH "tocdepth" QT_END_NAMESPACE |