diff options
author | Lars Knoll <lars.knoll@nokia.com> | 2009-03-23 09:18:55 (GMT) |
---|---|---|
committer | Simon Hausmann <simon.hausmann@nokia.com> | 2009-03-23 09:18:55 (GMT) |
commit | e5fcad302d86d316390c6b0f62759a067313e8a9 (patch) | |
tree | c2afbf6f1066b6ce261f14341cf6d310e5595bc1 /tools/qdoc3/javadocgenerator.h | |
download | Qt-e5fcad302d86d316390c6b0f62759a067313e8a9.zip Qt-e5fcad302d86d316390c6b0f62759a067313e8a9.tar.gz Qt-e5fcad302d86d316390c6b0f62759a067313e8a9.tar.bz2 |
Long live Qt 4.5!
Diffstat (limited to 'tools/qdoc3/javadocgenerator.h')
-rw-r--r-- | tools/qdoc3/javadocgenerator.h | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/tools/qdoc3/javadocgenerator.h b/tools/qdoc3/javadocgenerator.h new file mode 100644 index 0000000..aac938e --- /dev/null +++ b/tools/qdoc3/javadocgenerator.h @@ -0,0 +1,95 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Qt Software Information (qt-info@nokia.com) +** +** This file is part of the tools applications of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the either Technology Preview License Agreement or the +** Beta Release License Agreement. +** +** 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, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, 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. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at qt-sales@nokia.com. +** $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 ); + + void 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 |