forked from qt-creator/qt-creator
41411165ba
QDoc does some magic with the \class and \namespaces and \brief commands, so the following wording must be used: "The xxx class yyy ..." Change-Id: Id231f30e8464898b776888d5423523de404aae34 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
78 lines
2.6 KiB
C++
78 lines
2.6 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.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "PreprocessorClient.h"
|
|
|
|
using namespace CPlusPlus;
|
|
|
|
/*!
|
|
\class Client
|
|
\brief The Client class implements a notification interface for the
|
|
C++ preprocessor.
|
|
*/
|
|
|
|
/*!
|
|
\fn void Client::macroAdded(const Macro ¯o)
|
|
|
|
Called whenever a new macro is defined.
|
|
*/
|
|
|
|
/*!
|
|
\fn void Client::passedMacroDefinitionCheck(unsigned offset, const Macro ¯o)
|
|
|
|
Called when the preprocessor checks whether a macro is defined or not and the
|
|
result is positive.
|
|
|
|
\sa failedMacroDefinitionCheck()
|
|
*/
|
|
|
|
/*!
|
|
\fn void Client::failedMacroDefinitionCheck(unsigned offset, const QByteArray &name)
|
|
|
|
Called when the preprocessor checks whether a macro is defined or not and the
|
|
result is negative.
|
|
|
|
\sa passedMacroDefinitionCheck()
|
|
*/
|
|
|
|
/*!
|
|
\fn void Client::startExpandingMacro(unsigned offset, const Macro ¯o, const QByteArray &originalText, bool inCondition = false, const QVector<MacroArgumentReference> &actuals = QVector<MacroArgumentReference>())
|
|
|
|
Called when starting to expand a macro. The parameter \a inCondition indicates whether the
|
|
expansion is happening inside a preprocessor conditional.
|
|
|
|
\sa stopExpandingMacro()
|
|
*/
|
|
|
|
Client::Client()
|
|
{ }
|
|
|
|
Client::~Client()
|
|
{ }
|