summaryrefslogtreecommitdiffstats
path: root/src/assistant/help/qhelplink.cpp
blob: b606a1d8c6263d0581874c02667d6d6479a2527b (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
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Assistant of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:COMM$
**
** 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.
**
** $QT_END_LICENSE$
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
**
****************************************************************************/

#include "qhelplink.h"

/*!
    \class QHelpLink
    \since 5.15
    \inmodule QtHelp
    \brief The QHelpLink struct provides the data associated with a help link.

    The QHelpLink object is a data object that describes a link to a documentation file.
    The description of the help link contains the document title and URL of the document.
    \sa QHelpEngineCore
*/

/*!
    \variable QHelpLink::url
    \brief The target url of the link.
*/
/*!
    \variable QHelpLink::title
    \brief The title of the link.
*/