aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/ApiExtractor/qtdocparser.h
blob: f6ba5e47af4c0da2b1b8536129fa0f5aacaf24ba (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
// 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 QTDOCPARSER_H
#define QTDOCPARSER_H

#include "docparser.h"

struct ClassDocumentation;

class QtDocParser : public DocParser
{
public:
    QtDocParser() = default;
    void fillDocumentation(const AbstractMetaClassPtr &metaClass) override;
    void fillGlobalFunctionDocumentation(const AbstractMetaFunctionPtr &f) override;
    void fillGlobalEnumDocumentation(AbstractMetaEnum &e) override;

    Documentation retrieveModuleDocumentation() override;
    Documentation retrieveModuleDocumentation(const QString& name) override;

private:
    static QString functionDocumentation(const QString &sourceFileName,
                                         const ClassDocumentation &classDocumentation,
                                         const AbstractMetaClassCPtr &metaClass,
                                         const AbstractMetaFunctionCPtr &func,
                                         QString *errorMessage);

    static QString queryFunctionDocumentation(const QString &sourceFileName,
                                              const ClassDocumentation &classDocumentation,
                                              const AbstractMetaClassCPtr &metaClass,
                                              const AbstractMetaFunctionCPtr &func,
                                              QString *errorMessage);
    static bool extractEnumDocumentation(const ClassDocumentation &classDocumentation,
                                         AbstractMetaEnum &meta_enum);

};

#endif // QTDOCPARSER_H