tools/qdoc3/qscodemarker.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 /*
  43   qscodemarker.h
  44 */
  45
  46 #ifndef QSCODEMARKER_H
  47 #define QSCODEMARKER_H
  48
  49 #include "codemarker.h"
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 class QsCodeMarker : public CodeMarker
  54 {
  55 public:
  56     QsCodeMarker();
  57     ~QsCodeMarker();
  58
  59     bool recognizeCode( const QString& code );
  60     bool recognizeExtension( const QString& ext );
  61     bool recognizeLanguage( const QString& lang );
  62     QString plainName(const Node *node);
  63     QString plainFullName(const Node *node, const Node *relative);
  64     QString markedUpCode( const QString& code, const Node *relative,
  65                           const QString& dirPath );
  66     QString markedUpSynopsis( const Node *node, const Node *relative,
  67                               SynopsisStyle style );
  68     QString markedUpName( const Node *node );
  69     QString markedUpFullName( const Node *node, const Node *relative );
  70     QString markedUpEnumValue(const QString &enumValue, const Node *relative);
  71     QString markedUpIncludes( const QStringList& includes );
  72     QList<Section> sections(const InnerNode *innerNode, SynopsisStyle style, Status status);
  73     QString functionBeginRegExp( const QString& funcName );
  74     QString functionEndRegExp( const QString& funcName );
  75     const Node *resolveTarget( const QString& target, const Tree *tree, const Node *relative );
  76 };
  77
  78 QT_END_NAMESPACE
  79
  80 #endif