tools/qdoc3/javadocgenerator.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the tools applications of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef JAVADOCGENERATOR_H
  43 #define JAVADOCGENERATOR_H
  44
  45 #include "htmlgenerator.h"
  46
  47 QT_BEGIN_NAMESPACE
  48
  49 class JavadocGenerator : public HtmlGenerator
  50 {
  51 public:
  52     JavadocGenerator();
  53     ~JavadocGenerator();
  54
  55     void initializeGenerator(const Config &config);
  56     void terminateGenerator();
  57     QString format();
  58     bool canHandleFormat(const QString &format) { return format == "HTML" || format == "javadoc"; }
  59     void generateTree(const Tree *tree, CodeMarker *marker);
  60     QString typeString(const Node *node);
  61     QString imageFileName(const Node *relative, const QString &fileBase);
  62
  63 protected:
  64     QString fileExtension(const Node *node);
  65     void startText( const Node *relative, CodeMarker *marker );
  66     void endText( const Node *relative, CodeMarker *marker );
  67     int generateAtom( const Atom *atom, const Node *relative, CodeMarker *marker );
  68     void generateClassLikeNode(const InnerNode *inner, CodeMarker *marker);
  69     void generateFakeNode( const FakeNode *fake, CodeMarker *marker );
  70
  71     bool generateText( const Text& text, const Node *relative, CodeMarker *marker );
  72     void generateBody( const Node *node, CodeMarker *marker );
  73     void generateAlsoList( const Node *node, CodeMarker *marker );
  74
  75     QString refForNode( const Node *node );
  76     QString linkForNode( const Node *node, const Node *relative );
  77     QString refForAtom(Atom *atom, const Node *node);
  78
  79 private:
  80     void generateDcf(const QString &fileBase, const QString &startPage,
  81                      const QString &title, DcfSection &dcfRoot);
  82     void generateIndex(const QString &fileBase, const QString &url,
  83                        const QString &title);
  84     void generateIndent();
  85     void generateDoc(const Node *node, CodeMarker *marker);
  86     void generateEnumItemDoc(const Text &text, const Node *node, CodeMarker *marker);
  87
  88     QString buffer;
  89     QIODevice *oldDevice;
  90     int currentDepth;
  91 };
  92
  93 QT_END_NAMESPACE
  94
  95 #endif