blob: dd4becef1793fe312c056747b6d6db3fed6a1b77 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
/****************************************************************************
**
** 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.
*/
|
