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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/****************************************************************************
**
** Copyright (C) 2012 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 qthelp-index.html
\title Qt Help
\brief The QtHelp module provides classes for integrating
online documentation in applications.
\section1 Getting Started
To use Qt Help classes, add this directive into the C++ files:
\snippet doc_src_qthelp.cpp 0
To link against the Qt Help module, add this line to the project file:
\snippet doc_src_qthelp.qdoc 1
\section1 Articles and Guides
The classes and tools supplied with Qt to enable developers to include
online help and documentation in their applications are described in
more detail in \l{The Qt Help Framework}.
\section1 API Reference
These are links to the API reference material:
\list
\li \l{Qt Help C++ Classes}{C++ Classes}
\endlist
\section1 License Information
Qt Help uses the CLucene indexing library to provide full-text searching
capabilities for Qt Assistant and applications that use Qt Help features.
Developers using the \l{Qt Commercial License} who wish to distribute
applications that use the Qt Help features need to be aware of their
obligations under the GNU Lesser General Public License (LGPL).
Developers using the Open Source Edition can choose to redistribute
the module under the appropriate version of the GNU LGPL; version 2.1
for applications and libraries licensed under the GNU GPL version 2,
or version 3 for applications and libraries licensed under the GNU
GPL version 3.
\legalese
Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team \BR
Changes are Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
\endlegalese
*/
|
