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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef JAVADOCGENERATOR_H
#define JAVADOCGENERATOR_H
#include "htmlgenerator.h"
QT_BEGIN_NAMESPACE
class JavadocGenerator : public HtmlGenerator
{
public:
JavadocGenerator();
~JavadocGenerator();
void initializeGenerator(const Config &config);
void terminateGenerator();
QString format();
bool canHandleFormat(const QString &format) { return format == "HTML" || format == "javadoc"; }
void generateTree(const Tree *tree, CodeMarker *marker);
QString typeString(const Node *node);
QString imageFileName(const Node *relative, const QString &fileBase);
protected:
QString fileExtension(const Node *node);
void startText( const Node *relative, CodeMarker *marker );
void endText( const Node *relative, CodeMarker *marker );
int generateAtom( const Atom *atom, const Node *relative, CodeMarker *marker );
void generateClassLikeNode(const InnerNode *inner, CodeMarker *marker);
void generateFakeNode( const FakeNode *fake, CodeMarker *marker );
bool generateText( const Text& text, const Node *relative, CodeMarker *marker );
void generateBody( const Node *node, CodeMarker *marker );
void generateAlsoList( const Node *node, CodeMarker *marker );
QString refForNode( const Node *node );
QString linkForNode( const Node *node, const Node *relative );
QString refForAtom(Atom *atom, const Node *node);
private:
void generateDcf(const QString &fileBase, const QString &startPage,
const QString &title, DcfSection &dcfRoot);
void generateIndex(const QString &fileBase, const QString &url,
const QString &title);
void generateIndent();
void generateDoc(const Node *node, CodeMarker *marker);
void generateEnumItemDoc(const Text &text, const Node *node, CodeMarker *marker);
QString buffer;
QIODevice *oldDevice;
int currentDepth;
};
QT_END_NAMESPACE
#endif
|
