summaryrefslogtreecommitdiffstats
path: root/src/assistant/assistant/doc/src/assistant-example.qdoc
blob: 75291c7556de897f3912c01b24247e768c94fff2 (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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \group examples-qtassistant
    \ingroup all-examples
    \title Qt Assistant Examples
    \brief Using Qt Assistant as a help viewer for  Qt applications.

    \image assistant-examples.png

    Qt Assistant provides support for interactive help and enables you to
    display customer documentation to users of your Qt applications.

    The following examples illustrate how to use Qt Assistant as a help viewer
    for applications.

*/

/*
    \list
    \li \l{simpletextviewer}{Simple Text Viewer}\raisedaster
    \li \l{remotecontrol}{Remote Control}
    \endlist

    Examples marked with an asterisk (*) are fully documented.
*/