1/*
2 This file is part of the KDE libraries
3 SPDX-FileCopyrightText: 2012 David Faure <faure@kde.org>
4
5 SPDX-License-Identifier: LGPL-2.0-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
6*/
7
8#ifndef KHELPCLIENT_H
9#define KHELPCLIENT_H
10
11#include "kconfigwidgets_export.h"
12#include <QString>
13
14/*!
15 * \namespace KHelpClient
16 * \inmodule KConfigWidgets
17 *
18 * \brief Provides utility functions for access to help manuals.
19 */
20namespace KHelpClient
21{
22/*!
23 * Invokes the KHelpCenter HTML help viewer from docbook sources.
24 *
25 * The HTML file will be found using the X-DocPath entry in the application's desktop file.
26 * It can be either a relative path, or a website URL.
27 *
28 * \a anchor This has to be a defined anchor in your
29 * docbook sources or website. If empty the main index
30 * is loaded.
31 *
32 * \a appname This allows you to specify the .desktop file to get the help path from.
33 * If empty the QCoreApplication::applicationName() is used.
34 * \since 5.0
35 */
36KCONFIGWIDGETS_EXPORT void invokeHelp(const QString &anchor = QString(), const QString &appname = QString());
37}
38
39#endif /* KHELPCLIENT_H */
40

source code of kconfigwidgets/src/khelpclient.h