diff options
author | Pierre Rossi <pierre.rossi@digia.com> | 2012-09-25 14:35:12 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2012-09-28 07:32:55 +0200 |
commit | a1521579983860f4f7b02d6eddc478448715ac0b (patch) | |
tree | 7e32adda9392b5511f8f3dca9ddd662944b72d1a /src/tools/qdoc/doc/qdoc-manual.qdoc | |
parent | e47faabe238d856ff6c1454a7fc9483461206b37 (diff) |
QDoc: remove the experimental basedir variable
It was introduced in the early days of the docs'
modularization and appears not to be used anywhere
anymore.
Change-Id: I5b0c60d92828624af2129153fce96ad01aec861c
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/tools/qdoc/doc/qdoc-manual.qdoc')
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual.qdoc | 35 |
1 files changed, 0 insertions, 35 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual.qdoc b/src/tools/qdoc/doc/qdoc-manual.qdoc index 5aadc4727f..349aae61de 100644 --- a/src/tools/qdoc/doc/qdoc-manual.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual.qdoc @@ -7198,7 +7198,6 @@ \li \l {22-qdoc-configuration-generalvariables.html#alias-variable} {alias} \li \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoredirectives-variable} {Cpp.ignoredirectives} \li \l {23-qdoc-configuration-cppvariables.html#Cpp.ignoretokens-variable} {Cpp.ignoretokens} - \li \l {22-qdoc-configuration-generalvariables.html#basedir-variable} {basedir} \span {class="newStuff"} {(experimental)} \li \l {22-qdoc-configuration-generalvariables.html#defines-variable} {defines} \li \l {22-qdoc-configuration-generalvariables.html#edition-variable} {edition} \li \l {22-qdoc-configuration-generalvariables.html#exampledirs-variable} {exampledirs} @@ -7371,40 +7370,6 @@ to adjust the appearance of certain types of HTML elements, this level of indentation is not always required. - \target basedir-variable - \section1 basedir - - The \c basedir variable tells QDoc two things. First, the fact that - it is set it tells QDoc to the put the output files in subdirectories - of the output directory. Second, the value of basedir is the name of - the bundle directory for your project. .e.g. if you are working with - the Qt5 bundle, you will have checked out the bundle into some root - subdirectory (the base directory), and that root directory might - very well be \e {qt5} - - Then in your qdocconf file, you would assign to the basedir variable: - - \code - basedir = qt5 - \endcode - - Now, QDoc knows to scan the file path of each source file it parses, - looking for \e qt5. For example, this file would be: - - \code - ~/depot/qt5/qtdoc/tools/qdoc/doc/qdoc-manual.qdoc - \endcode - - QDoc scans the path for the basedir \e{qt5} and the next subdirectory - \e{qtdoc} becomes one of the subdirectories in the output directory. - The HTML output file created from this file will be stored in the - \e{qtdoc} subdirectory. - - \note This is an experimental command. It is currently used only by - the Qt documentation group. If you use it, be advised that you might - find some broken links in your HTML output due to remaining problems - with cross-subdirectory linking. - \target defines-variable \section1 defines |