summaryrefslogtreecommitdiffstats
path: root/src/assistant/help/qhelplink.cpp
blob: 91c1f4fbc7daa47d7ee633215688c0bb18930352 (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
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#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.
*/