summaryrefslogtreecommitdiffstats
path: root/src/assistant/qhelpgenerator/helpgenerator.h
blob: 8c5ef343dd6945b0a62e2bba6ba5df0fcb19202d (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
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#ifndef HELPGENERATOR_H
#define HELPGENERATOR_H

#include <QtCore/QObject>

QT_BEGIN_NAMESPACE

class QHelpProjectData;
class HelpGeneratorPrivate;

class HelpGenerator : public QObject
{
    Q_OBJECT

public:
    HelpGenerator(bool silent = false);
    bool generate(QHelpProjectData *helpData,
        const QString &outputFileName);
    bool checkLinks(const QHelpProjectData &helpData);
    QString error() const;

private slots:
    void printStatus(const QString &msg);
    void printWarning(const QString &msg);

private:
    HelpGeneratorPrivate *m_private;
};

QT_END_NAMESPACE

#endif