diff options
author | Nico Vertriest <nico.vertriest@digia.com> | 2013-09-09 13:22:12 +0200 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-09-10 13:26:59 +0200 |
commit | c9c435179eddd4f252658b1106b924441168ca56 (patch) | |
tree | e0dad5e641c25f29380e6188cbfae6a98992c7f6 /src/tools/qdoc/doc/qdoc-manual-qdocconf-minimal.qdoc | |
parent | 6d1f8575a3b034583a25c12d29d8897f6c6ebe1a (diff) |
Doc: split up Qdoc-manual
qdoc-manual.qdoc is now an overview document
Each section is a separate qdoc file
Title modification in minimal qdocconf qdoc file
Task-number: QTBUG-31801
Change-Id: I9e50eb8c4f1f501e9c0bc768372d4393b73053ed
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/tools/qdoc/doc/qdoc-manual-qdocconf-minimal.qdoc')
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-qdocconf-minimal.qdoc | 78 |
1 files changed, 0 insertions, 78 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual-qdocconf-minimal.qdoc b/src/tools/qdoc/doc/qdoc-manual-qdocconf-minimal.qdoc deleted file mode 100644 index dd4becef17..0000000000 --- a/src/tools/qdoc/doc/qdoc-manual-qdocconf-minimal.qdoc +++ /dev/null @@ -1,78 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). -** Contact: http://www.qt-project.org/legal -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and Digia. For licensing terms and -** conditions see http://qt.digia.com/licensing. For further information -** use the contact form at http://qt.digia.com/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ -/*! -\page qdoc-manual-qdocconf-minimal -\title Minimal qdocconf file -\brief Describes a qdocconf file with a minimal number of statements - -The full contents of the minimal qdocconf file: - -\code - #include(compat.qdocconf) - headerdirs = . - sourcedirs = . - exampledirs = . - imagedirs = ./images - -\endcode - -\title Statements with Comments - -\code - #include(compat.qdocconf) -\endcode - -In order to avoid compatibility issues between different versions of QDoc, -it is advised to include compat.qdocconf. - -\code - headerdirs = . -\endcode - -The header files associated with the .cpp source files can be found in the -current directory. - -\code - #sourcedirs = . -\endcode - -The .cpp or .qdoc files can be found in the current directory. - -\code - exampledirs = . -\endcode - -The source code of the example files can be found in the current directory. - -\code - imagedirs = ./images -\endcode - -The images used in the documentation can be found in subdirectory \e images. - -\note Please take care with this minimal qdocconf file. Using it in the wrong directory could cause qdoc to include a large number of files. -*/ |