forked from qt-creator/qt-creator
35211c04b1
QDoc does not look for docs in header files. Change-Id: I4530233d647fdc2f5ca44c73aee7e0125df07979 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
85 lines
2.9 KiB
C++
85 lines
2.9 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2013 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 CPLUSPLUS_OVERVIEW_H
|
|
#define CPLUSPLUS_OVERVIEW_H
|
|
|
|
#include <cplusplus/CPlusPlusForwardDeclarations.h>
|
|
|
|
#include <QList>
|
|
#include <QString>
|
|
|
|
namespace CPlusPlus {
|
|
|
|
class CPLUSPLUS_EXPORT Overview
|
|
{
|
|
public:
|
|
Overview();
|
|
|
|
QString operator()(const Name *name) const
|
|
{ return prettyName(name); }
|
|
|
|
QString operator()(const QList<const Name *> &fullyQualifiedName) const
|
|
{ return prettyName(fullyQualifiedName); }
|
|
|
|
QString operator()(const FullySpecifiedType &type, const Name *name = 0) const
|
|
{ return prettyType(type, name); }
|
|
|
|
QString prettyName(const Name *name) const;
|
|
QString prettyName(const QList<const Name *> &fullyQualifiedName) const;
|
|
QString prettyType(const FullySpecifiedType &type, const Name *name = 0) const;
|
|
QString prettyType(const FullySpecifiedType &type, const QString &name) const;
|
|
|
|
public:
|
|
|
|
enum StarBindFlag {
|
|
BindToIdentifier = 0x1,
|
|
BindToTypeName = 0x2,
|
|
BindToLeftSpecifier = 0x4,
|
|
BindToRightSpecifier = 0x8
|
|
};
|
|
Q_DECLARE_FLAGS(StarBindFlags, StarBindFlag)
|
|
|
|
StarBindFlags starBindFlags;
|
|
bool showArgumentNames: 1;
|
|
bool showReturnTypes: 1;
|
|
bool showFunctionSignatures: 1;
|
|
bool showDefaultArguments: 1;
|
|
bool showTemplateParameters: 1;
|
|
bool includeWhiteSpaceInOperatorName: 1; /// "operator =()" vs "operator=()"
|
|
|
|
unsigned markedArgument;
|
|
int markedArgumentBegin;
|
|
int markedArgumentEnd;
|
|
};
|
|
|
|
} // namespace CPlusPlus
|
|
|
|
#endif // CPLUSPLUS_OVERVIEW_H
|