forked from qt-creator/qt-creator
386ca7c8dd
Change-Id: Ice592c6de9951ee3b2c4cb52ed0bb3b6770e0825 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
101 lines
3.1 KiB
C++
101 lines
3.1 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
|
|
** Contact: http://www.qt-project.org/legal
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** 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.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#ifndef DOXYGEGENERATOR_H
|
|
#define DOXYGEGENERATOR_H
|
|
|
|
#include "cpptools_global.h"
|
|
|
|
#include <cplusplus/Overview.h>
|
|
|
|
#include <QLatin1String>
|
|
#include <QTextCursor>
|
|
|
|
namespace CPlusPlus {
|
|
class DeclarationAST;
|
|
}
|
|
|
|
namespace CppTools {
|
|
|
|
class CPPTOOLS_EXPORT DoxygenGenerator
|
|
{
|
|
public:
|
|
DoxygenGenerator();
|
|
|
|
enum DocumentationStyle {
|
|
JavaStyle,
|
|
QtStyle
|
|
};
|
|
|
|
void setStyle(DocumentationStyle style);
|
|
void setStartComment(bool start);
|
|
void setGenerateBrief(bool gen);
|
|
void setAddLeadingAsterisks(bool add);
|
|
|
|
QString generate(QTextCursor cursor);
|
|
QString generate(QTextCursor cursor, CPlusPlus::DeclarationAST *decl);
|
|
|
|
private:
|
|
QChar startMark() const;
|
|
QChar styleMark() const;
|
|
|
|
enum Command {
|
|
BriefCommand,
|
|
ParamCommand,
|
|
ReturnCommand
|
|
};
|
|
static QString commandSpelling(Command command);
|
|
|
|
void writeStart(QString *comment) const;
|
|
void writeEnd(QString *comment) const;
|
|
void writeContinuation(QString *comment) const;
|
|
void writeNewLine(QString *comment) const;
|
|
void writeCommand(QString *comment,
|
|
Command command,
|
|
const QString &commandContent = QString()) const;
|
|
void writeBrief(QString *comment,
|
|
const QString &brief,
|
|
const QString &prefix = QString(),
|
|
const QString &suffix = QString());
|
|
|
|
void assignCommentOffset(QTextCursor cursor);
|
|
QString offsetString() const;
|
|
|
|
bool m_addLeadingAsterisks;
|
|
bool m_generateBrief;
|
|
bool m_startComment;
|
|
DocumentationStyle m_style;
|
|
CPlusPlus::Overview m_printer;
|
|
QString m_commentOffset;
|
|
};
|
|
|
|
} // CppTools
|
|
|
|
#endif // DOXYGEGENERATOR_H
|