feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: fix function signatures in code documentation

Browse Source 
QDoc cannot find functions if the signature in the \fn command
is not identical to the declaration, including 'const' qualifiers.

Removed the \fn where the documentation comes immediately before the
function, as qdoc does not need it in that case.

Change-Id: If6a2a2e2d58b394905c803787d2a93489049e4ca
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
Leena Miettinen
2013-05-23 16:13:55 +02:00
parent c88d7be702
commit 26c412deac
23 changed files with 75 additions and 211 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/libs/cplusplus/PreprocessorClient.cpp
View File

@@ -43,7 +43,7 @@ using namespace CPlusPlus;
*/ */
/*! /*!
\fn void Client::passedMacroDefinitionCheck(unsigned offset, const Macro &macro) \fn void Client::passedMacroDefinitionCheck(unsigned offset, unsigned line, const Macro &macro)
Called when the preprocessor checks whether a macro is defined or not and the Called when the preprocessor checks whether a macro is defined or not and the
result is positive. result is positive.
@@ -52,7 +52,7 @@ using namespace CPlusPlus;
*/ */
/*! /*!
\fn void Client::failedMacroDefinitionCheck(unsigned offset, const QByteArray &name) \fn void Client::failedMacroDefinitionCheck(unsigned offset, const ByteArrayRef &name)
Called when the preprocessor checks whether a macro is defined or not and the Called when the preprocessor checks whether a macro is defined or not and the
result is negative. result is negative.
@@ -61,10 +61,12 @@ using namespace CPlusPlus;
*/ */
/*! /*!
\fn void Client::startExpandingMacro(unsigned offset, const Macro &macro, const QByteArray &originalText, bool inCondition = false, const QVector<MacroArgumentReference> &actuals = QVector<MacroArgumentReference>()) \fn void Client::startExpandingMacro(unsigned offset,
unsigned line,
Called when starting to expand a macro. The parameter \a inCondition indicates whether the const Macro &macro,
expansion is happening inside a preprocessor conditional. const QVector<MacroArgumentReference> &actuals
= QVector<MacroArgumentReference>())
Called when starting to expand a macro.
\sa stopExpandingMacro() \sa stopExpandingMacro()
*/ */

58
src/libs/extensionsystem/pluginmanager.cpp
View File

@@ -213,7 +213,8 @@ enum { debugLeaks = 0 };
*/ */
/*! /*!
\fn T *PluginManager::getObject() const \fn T *PluginManager::getObject()
Retrieve the object of a given type from the object pool. Retrieve the object of a given type from the object pool.
This method is aware of Aggregation::Aggregate, i.e. it uses This method is aware of Aggregation::Aggregate, i.e. it uses
the Aggregation::query methods instead of qobject_cast to the Aggregation::query methods instead of qobject_cast to
@@ -225,7 +226,7 @@ enum { debugLeaks = 0 };
*/ */
/*! /*!
\fn QList<T *> PluginManager::getObjects() const \fn QList<T *> PluginManager::getObjects()
Retrieve all objects of a given type from the object pool. Retrieve all objects of a given type from the object pool.
This method is aware of Aggregation::Aggregate, i.e. it uses This method is aware of Aggregation::Aggregate, i.e. it uses
the Aggregation::query methods instead of qobject_cast to the Aggregation::query methods instead of qobject_cast to
@@ -245,7 +246,6 @@ static bool lessThanByPluginName(const PluginSpec *one, const PluginSpec *two)
PluginManager *PluginManager::m_instance = 0; PluginManager *PluginManager::m_instance = 0;
/*! /*!
\fn PluginManager *PluginManager::instance()
Get the unique plugin manager instance. Get the unique plugin manager instance.
*/ */
PluginManager *PluginManager::instance() PluginManager *PluginManager::instance()
@@ -254,7 +254,6 @@ PluginManager *PluginManager::instance()
} }
/*! /*!
\fn PluginManager::PluginManager()
Create a plugin manager. Should be done only once per application. Create a plugin manager. Should be done only once per application.
*/ */
PluginManager::PluginManager() PluginManager::PluginManager()
@@ -264,7 +263,6 @@ PluginManager::PluginManager()
} }
/*! /*!
\fn PluginManager::~PluginManager()
\internal \internal
*/ */
PluginManager::~PluginManager() PluginManager::~PluginManager()
@@ -274,7 +272,6 @@ PluginManager::~PluginManager()
} }
/*! /*!
\fn void PluginManager::addObject(QObject *obj)
Add the given object \a obj to the object pool, so it can be retrieved again from the pool by type. Add the given object \a obj to the object pool, so it can be retrieved again from the pool by type.
The plugin manager does not do any memory management - added objects The plugin manager does not do any memory management - added objects
must be removed from the pool and deleted manually by whoever is responsible for the object. must be removed from the pool and deleted manually by whoever is responsible for the object.
@@ -291,7 +288,6 @@ void PluginManager::addObject(QObject *obj)
} }
/*! /*!
\fn void PluginManager::removeObject(QObject *obj)
Emits aboutToRemoveObject() and removes the object \a obj from the object pool. Emits aboutToRemoveObject() and removes the object \a obj from the object pool.
\sa PluginManager::addObject() \sa PluginManager::addObject()
*/ */
@@ -301,7 +297,6 @@ void PluginManager::removeObject(QObject *obj)
} }
/*! /*!
\fn QList<QObject *> PluginManager::allObjects() const
Retrieve the list of all objects in the pool, unfiltered. Retrieve the list of all objects in the pool, unfiltered.
Usually clients do not need to call this. Usually clients do not need to call this.
\sa PluginManager::getObject() \sa PluginManager::getObject()
@@ -313,7 +308,6 @@ QList<QObject *> PluginManager::allObjects()
} }
/*! /*!
\fn void PluginManager::loadPlugins()
Tries to load all the plugins that were previously found when Tries to load all the plugins that were previously found when
setting the plugin search paths. The plugin specs of the plugins setting the plugin search paths. The plugin specs of the plugins
can be used to retrieve error and state information about individual plugins. can be used to retrieve error and state information about individual plugins.
@@ -327,7 +321,6 @@ void PluginManager::loadPlugins()
} }
/*! /*!
\fn bool PluginManager::hasError() const
Returns true if any plugin has errors even though it is enabled. Returns true if any plugin has errors even though it is enabled.
Most useful to call after loadPlugins(). Most useful to call after loadPlugins().
*/ */
@@ -342,7 +335,6 @@ bool PluginManager::hasError()
} }
/*! /*!
\fn void PluginManager::shutdown()
Shuts down and deletes all plugins. Shuts down and deletes all plugins.
*/ */
void PluginManager::shutdown() void PluginManager::shutdown()
@@ -351,7 +343,6 @@ void PluginManager::shutdown()
} }
/*! /*!
\fn QStringList PluginManager::pluginPaths() const
The list of paths were the plugin manager searches for plugins. The list of paths were the plugin manager searches for plugins.
\sa setPluginPaths() \sa setPluginPaths()
@@ -362,7 +353,6 @@ QStringList PluginManager::pluginPaths()
} }
/*! /*!
\fn void PluginManager::setPluginPaths(const QStringList &paths)
Sets the plugin search paths, i.e. the file system paths where the plugin manager Sets the plugin search paths, i.e. the file system paths where the plugin manager
looks for plugin descriptions. All given \a paths and their sub directory trees looks for plugin descriptions. All given \a paths and their sub directory trees
are searched for plugin xml description files. are searched for plugin xml description files.
@@ -376,7 +366,6 @@ void PluginManager::setPluginPaths(const QStringList &paths)
} }
/*! /*!
\fn QString PluginManager::fileExtension() const
The file extension of plugin description files. The file extension of plugin description files.
The default is "xml". The default is "xml".
@@ -388,7 +377,6 @@ QString PluginManager::fileExtension()
} }
/*! /*!
\fn void PluginManager::setFileExtension(const QString &extension)
Sets the file extension of plugin description files. Sets the file extension of plugin description files.
The default is "xml". The default is "xml".
At the moment this must be called before setPluginPaths() is called. At the moment this must be called before setPluginPaths() is called.
@@ -439,7 +427,6 @@ void PluginManager::writeSettings()
} }
/*! /*!
\fn QStringList PluginManager::arguments() const
The arguments left over after parsing (Neither startup nor plugin The arguments left over after parsing (Neither startup nor plugin
arguments). Typically, this will be the list of files to open. arguments). Typically, this will be the list of files to open.
*/ */
@@ -449,7 +436,6 @@ QStringList PluginManager::arguments()
} }
/*! /*!
\fn QList<PluginSpec *> PluginManager::plugins() const
List of all plugin specifications that have been found in the plugin search paths. List of all plugin specifications that have been found in the plugin search paths.
This list is valid directly after the setPluginPaths() call. This list is valid directly after the setPluginPaths() call.
The plugin specifications contain the information from the plugins' xml description files The plugin specifications contain the information from the plugins' xml description files
@@ -469,8 +455,6 @@ QHash<QString, PluginCollection *> PluginManager::pluginCollections()
} }
/*! /*!
\fn QString PluginManager::serializedArguments() const
Serialize plugin options and arguments for sending in a single string Serialize plugin options and arguments for sending in a single string
via QtSingleApplication: via QtSingleApplication:
":myplugin|-option1|-option2|:arguments|argument1|argument2", ":myplugin|-option1|-option2|:arguments|argument1|argument2",
@@ -532,8 +516,6 @@ static QStringList subList(const QStringList &in, const QString &key)
} }
/*! /*!
\fn PluginManager::remoteArguments(const QString &argument, QObject *socket)
Parses the options encoded by serializedArguments() const Parses the options encoded by serializedArguments() const
and passes them on to the respective plugins along with the arguments. and passes them on to the respective plugins along with the arguments.
@@ -562,7 +544,6 @@ void PluginManager::remoteArguments(const QString &serializedArgument, QObject *
} }
/*! /*!
\fn bool PluginManager::parseOptions(const QStringList &args, const QMap<QString, bool> &appOptions, QMap<QString, QString> *foundAppOptions, QString *errorString)
Takes the list of command line options in \a args and parses them. Takes the list of command line options in \a args and parses them.
The plugin manager itself might process some options itself directly (-noload <plugin>), and The plugin manager itself might process some options itself directly (-noload <plugin>), and
adds options that are registered by plugins to their plugin specs. adds options that are registered by plugins to their plugin specs.
@@ -611,8 +592,6 @@ static inline void formatOption(QTextStream &str,
} }
/*! /*!
\fn static PluginManager::formatOptions(QTextStream &str, int optionIndentation, int descriptionIndentation)
Format the startup options of the plugin manager for command line help. Format the startup options of the plugin manager for command line help.
*/ */
@@ -638,8 +617,6 @@ void PluginManager::formatOptions(QTextStream &str, int optionIndentation, int d
} }
/*! /*!
\fn PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation, int descriptionIndentation) const
Format the plugin options of the plugin specs for command line help. Format the plugin options of the plugin specs for command line help.
*/ */
@@ -660,8 +637,6 @@ void PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation,
} }
/*! /*!
\fn PluginManager::formatPluginVersions(QTextStream &str) const
Format the version of the plugin specs for command line help. Format the version of the plugin specs for command line help.
*/ */
@@ -747,7 +722,6 @@ void PluginManager::startTests()
} }
/*! /*!
* \fn bool PluginManager::runningTests() const
* \internal * \internal
*/ */
bool PluginManager::testRunRequested() bool PluginManager::testRunRequested()
@@ -756,7 +730,6 @@ bool PluginManager::testRunRequested()
} }
/*! /*!
* \fn QString PluginManager::testDataDirectory() const
* \internal * \internal
*/ */
QString PluginManager::testDataDirectory() QString PluginManager::testDataDirectory()
@@ -772,8 +745,6 @@ QString PluginManager::testDataDirectory()
} }
/*! /*!
\fn void PluginManager::profilingReport(const char *what, const PluginSpec *spec = 0)
Create a profiling entry showing the elapsed time if profiling is activated. Create a profiling entry showing the elapsed time if profiling is activated.
*/ */
@@ -784,8 +755,6 @@ void PluginManager::profilingReport(const char *what, const PluginSpec *spec)
/*! /*!
\fn void PluginManager::loadQueue()
Returns a list of plugins in load order. Returns a list of plugins in load order.
*/ */
QList<PluginSpec *> PluginManager::loadQueue() QList<PluginSpec *> PluginManager::loadQueue()
@@ -796,7 +765,6 @@ QList<PluginSpec *> PluginManager::loadQueue()
//============PluginManagerPrivate=========== //============PluginManagerPrivate===========
/*! /*!
\fn PluginSpec *PluginManagerPrivate::createSpec()
\internal \internal
*/ */
PluginSpec *PluginManagerPrivate::createSpec() PluginSpec *PluginManagerPrivate::createSpec()
@@ -805,7 +773,6 @@ PluginSpec *PluginManagerPrivate::createSpec()
} }
/*! /*!
\fn void PluginManagerPrivate::setSettings(QSettings *settings)
\internal \internal
*/ */
void PluginManagerPrivate::setSettings(QSettings *s) void PluginManagerPrivate::setSettings(QSettings *s)
@@ -830,7 +797,6 @@ void PluginManagerPrivate::setGlobalSettings(QSettings *s)
} }
/*! /*!
\fn PluginSpecPrivate *PluginManagerPrivate::privateSpec(PluginSpec *spec)
\internal \internal
*/ */
PluginSpecPrivate *PluginManagerPrivate::privateSpec(PluginSpec *spec) PluginSpecPrivate *PluginManagerPrivate::privateSpec(PluginSpec *spec)
@@ -859,7 +825,6 @@ void PluginManagerPrivate::nextDelayedInitialize()
} }
/*! /*!
\fn PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager)
\internal \internal
*/ */
PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager) : PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager) :
@@ -876,7 +841,6 @@ PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager) :
/*! /*!
\fn PluginManagerPrivate::~PluginManagerPrivate()
\internal \internal
*/ */
PluginManagerPrivate::~PluginManagerPrivate() PluginManagerPrivate::~PluginManagerPrivate()
@@ -886,7 +850,6 @@ PluginManagerPrivate::~PluginManagerPrivate()
} }
/*! /*!
\fn void PluginManagerPrivate::writeSettings()
\internal \internal
*/ */
void PluginManagerPrivate::writeSettings() void PluginManagerPrivate::writeSettings()
@@ -907,7 +870,6 @@ void PluginManagerPrivate::writeSettings()
} }
/*! /*!
\fn void PluginManagerPrivate::readSettings()
\internal \internal
*/ */
void PluginManagerPrivate::readSettings() void PluginManagerPrivate::readSettings()
@@ -921,7 +883,6 @@ void PluginManagerPrivate::readSettings()
} }
/*! /*!
\fn void PluginManagerPrivate::stopAll()
\internal \internal
*/ */
void PluginManagerPrivate::stopAll() void PluginManagerPrivate::stopAll()
@@ -938,7 +899,6 @@ void PluginManagerPrivate::stopAll()
} }
/*! /*!
\fn void PluginManagerPrivate::deleteAll()
\internal \internal
*/ */
void PluginManagerPrivate::deleteAll() void PluginManagerPrivate::deleteAll()
@@ -952,7 +912,6 @@ void PluginManagerPrivate::deleteAll()
} }
/*! /*!
\fn void PluginManagerPrivate::addObject(QObject *obj)
\internal \internal
*/ */
void PluginManagerPrivate::addObject(QObject *obj) void PluginManagerPrivate::addObject(QObject *obj)
@@ -984,7 +943,6 @@ void PluginManagerPrivate::addObject(QObject *obj)
} }
/*! /*!
\fn void PluginManagerPrivate::removeObject(QObject *obj)
\internal \internal
*/ */
void PluginManagerPrivate::removeObject(QObject *obj) void PluginManagerPrivate::removeObject(QObject *obj)
@@ -1008,7 +966,6 @@ void PluginManagerPrivate::removeObject(QObject *obj)
} }
/*! /*!
\fn void PluginManagerPrivate::loadPlugins()
\internal \internal
*/ */
void PluginManagerPrivate::loadPlugins() void PluginManagerPrivate::loadPlugins()
@@ -1039,7 +996,6 @@ void PluginManagerPrivate::loadPlugins()
} }
/*! /*!
\fn void PluginManagerPrivate::shutdown()
\internal \internal
*/ */
void PluginManagerPrivate::shutdown() void PluginManagerPrivate::shutdown()
@@ -1055,7 +1011,6 @@ void PluginManagerPrivate::shutdown()
} }
/*! /*!
\fn void PluginManagerPrivate::asyncShutdownFinished()
\internal \internal
*/ */
void PluginManagerPrivate::asyncShutdownFinished() void PluginManagerPrivate::asyncShutdownFinished()
@@ -1068,7 +1023,6 @@ void PluginManagerPrivate::asyncShutdownFinished()
} }
/*! /*!
\fn void PluginManagerPrivate::loadQueue()
\internal \internal
*/ */
QList<PluginSpec *> PluginManagerPrivate::loadQueue() QList<PluginSpec *> PluginManagerPrivate::loadQueue()
@@ -1082,7 +1036,6 @@ QList<PluginSpec *> PluginManagerPrivate::loadQueue()
} }
/*! /*!
\fn bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList<PluginSpec *> &queue, QList<PluginSpec *> &circularityCheckQueue)
\internal \internal
*/ */
bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList<PluginSpec *> &queue, bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList<PluginSpec *> &queue,
@@ -1125,7 +1078,6 @@ bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList<PluginSpec *> &queu
} }
/*! /*!
\fn void PluginManagerPrivate::loadPlugin(PluginSpec *spec, PluginSpec::State destState)
\internal \internal
*/ */
void PluginManagerPrivate::loadPlugin(PluginSpec *spec, PluginSpec::State destState) void PluginManagerPrivate::loadPlugin(PluginSpec *spec, PluginSpec::State destState)
@@ -1192,7 +1144,6 @@ void PluginManagerPrivate::loadPlugin(PluginSpec *spec, PluginSpec::State destSt
} }
/*! /*!
\fn void PluginManagerPrivate::setPluginPaths(const QStringList &paths)
\internal \internal
*/ */
void PluginManagerPrivate::setPluginPaths(const QStringList &paths) void PluginManagerPrivate::setPluginPaths(const QStringList &paths)
@@ -1203,7 +1154,6 @@ void PluginManagerPrivate::setPluginPaths(const QStringList &paths)
} }
/*! /*!
\fn void PluginManagerPrivate::readPluginPaths()
\internal \internal
*/ */
void PluginManagerPrivate::readPluginPaths() void PluginManagerPrivate::readPluginPaths()
@@ -1361,7 +1311,6 @@ void PluginManagerPrivate::profilingSummary() const
} }
/*! /*!
\fn void PluginManager::getObjectByName(const QString &name) const
\brief Retrieves one object with a given name from the object pool. \brief Retrieves one object with a given name from the object pool.
\sa addObject() \sa addObject()
*/ */
@@ -1378,7 +1327,6 @@ QObject *PluginManager::getObjectByName(const QString &name)
} }
/*! /*!
\fn void PluginManager::getObjectByClassName(const QString &className) const
Retrieves one object inheriting a class with a given name from the object pool. Retrieves one object inheriting a class with a given name from the object pool.
\sa addObject() \sa addObject()
*/ */

3
src/libs/extensionsystem/pluginview.cpp
View File

@@ -70,7 +70,6 @@ Q_DECLARE_METATYPE(ExtensionSystem::PluginSpec*)
Q_DECLARE_METATYPE(ExtensionSystem::PluginCollection*) Q_DECLARE_METATYPE(ExtensionSystem::PluginCollection*)
/*! /*!
\fn PluginView::PluginView(PluginManager *manager, QWidget *parent)
Constructs a PluginView that gets the list of plugins from the Constructs a PluginView that gets the list of plugins from the
given plugin \a manager with a given \a parent widget. given plugin \a manager with a given \a parent widget.
*/ */
@@ -105,7 +104,6 @@ PluginView::PluginView(QWidget *parent)
} }
/*! /*!
\fn PluginView::~PluginView()
\internal \internal
*/ */
PluginView::~PluginView() PluginView::~PluginView()
@@ -114,7 +112,6 @@ PluginView::~PluginView()
} }
/*! /*!
\fn PluginSpec *PluginView::currentPlugin() const
Returns the current selection in the list of plugins. Returns the current selection in the list of plugins.
*/ */
PluginSpec *PluginView::currentPlugin() const PluginSpec *PluginView::currentPlugin() const

4
src/libs/qmljs/persistenttrie.cpp
View File

@@ -642,8 +642,6 @@ Trie Trie::replaceF(const QHash<QString, QString> &replacements) const
} }
/*! /*!
\fn int matchStrength(const QString &searchStr, const QString &str)
Returns a number defining how well the serachStr matches str. Returns a number defining how well the serachStr matches str.
Quite simplistic, looks only at the first match, and prefers contiguos Quite simplistic, looks only at the first match, and prefers contiguos
@@ -692,8 +690,6 @@ public:
} }
/*! /*!
\fn QStringList matchingStrengthSort(const QString &searchStr, QStringList &res)
returns a number defining the matching strength of res to the given searchStr returns a number defining the matching strength of res to the given searchStr
*/ */
QStringList matchStrengthSort(const QString &searchStr, QStringList &res) QStringList matchStrengthSort(const QString &searchStr, QStringList &res)

15
src/plugins/coreplugin/actionmanager/actioncontainer.cpp
View File

@@ -117,13 +117,13 @@ using namespace Core::Internal;
*/ */
/*! /*!
\fn QAction *ActionContainer::insertLocation(const Core::Id &group) const \fn QAction *ActionContainer::insertLocation(const Id &group) const
Returns an action representing the \a group, Returns an action representing the \a group,
that could be used with \c{QWidget::insertAction}. that could be used with \c{QWidget::insertAction}.
*/ */
/*! /*!
\fn void ActionContainer::appendGroup(const QString &identifier) \fn void ActionContainer::appendGroup(const Id &group)
Adds a group with the given \a identifier to the action container. Using groups Adds a group with the given \a identifier to the action container. Using groups
you can segment your action container into logical parts and add actions and you can segment your action container into logical parts and add actions and
menus directly to these parts. menus directly to these parts.
@@ -132,7 +132,7 @@ using namespace Core::Internal;
*/ */
/*! /*!
\fn void ActionContainer::addAction(Core::Command *action, const Core::Id &group) \fn void ActionContainer::addAction(Command *action, const Id &group = Id())
Add the \a action as a menu item to this action container. The action is added as the Add the \a action as a menu item to this action container. The action is added as the
last item of the specified \a group. last item of the specified \a group.
\sa appendGroup() \sa appendGroup()
@@ -140,18 +140,13 @@ using namespace Core::Internal;
*/ */
/*! /*!
\fn void ActionContainer::addMenu(Core::ActionContainer *menu, const Core::Id &group) \fn void ActionContainer::addMenu(ActionContainer *menu, const Id &group = Id())
Add the \a menu as a submenu to this action container. The menu is added as the Add the \a menu as a submenu to this action container. The menu is added as the
last item of the specified \a group. last item of the specified \a group.
\sa appendGroup() \sa appendGroup()
\sa addAction() \sa addAction()
*/ */
/*!
\fn ActionContainer::~ActionContainer()
\internal
*/
// ---------- ActionContainerPrivate ------------ // ---------- ActionContainerPrivate ------------
/*! /*!
@@ -290,8 +285,6 @@ void ActionContainerPrivate::addMenu(ActionContainer *before, ActionContainer *m
} }
/*! /*!
* \fn Command *ActionContainer::addSeparator(const Context &context, const Id &group, QAction **outSeparator)
*
* Adds a separator to the end of the given \a group to the action container, which is enabled * Adds a separator to the end of the given \a group to the action container, which is enabled
* for a given \a context. The created separator action is returned through \a outSeparator. * for a given \a context. The created separator action is returned through \a outSeparator.
* *

5
src/plugins/coreplugin/actionmanager/command.cpp
View File

@@ -200,11 +200,6 @@
interact with it. interact with it.
*/ */
/*!
\fn Command::~Command()
\internal
*/
using namespace Core; using namespace Core;
using namespace Core::Internal; using namespace Core::Internal;

3
src/plugins/coreplugin/basefilewizard.cpp
View File

@@ -559,8 +559,7 @@ Core::IWizard::WizardFlags BaseFileWizard::flags() const
/*! /*!
\fn virtual QWizard *Core::BaseFileWizard::createWizardDialog(QWidget *parent, \fn virtual QWizard *Core::BaseFileWizard::createWizardDialog(QWidget *parent,
const QString &defaultPath, const WizardDialogParameters &wizardDialogParameters) const
const WizardPageList &extensionPages) const = 0
\brief Implement to create the wizard dialog on the parent, adding the extension pages. \brief Implement to create the wizard dialog on the parent, adding the extension pages.
*/ */

6
src/plugins/coreplugin/dialogs/iwizard.cpp
View File

@@ -128,7 +128,11 @@
*/ */
/*! /*!
\fn void IWizard::runWizard(const QString &path, QWidget *parent) \fn void IWizard::runWizard(const QString &path,
QWidget *parent,
const QString &platform,
const QVariantMap &variables)
This method is executed when the wizard has been selected by the user This method is executed when the wizard has been selected by the user
for execution. Any dialogs the wizard opens should use the given \a parent. for execution. Any dialogs the wizard opens should use the given \a parent.
The \a path argument is a suggestion for the location where files should be The \a path argument is a suggestion for the location where files should be

30
src/plugins/coreplugin/documentmanager.cpp
View File

@@ -273,8 +273,6 @@ static void addFileInfo(IDocument *document)
} }
/*! /*!
\fn bool DocumentManager::addFiles(const QList<IDocument *> &documents, bool addWatcher)
Adds a list of IDocument's to the collection. If \a addWatcher is true (the default), Adds a list of IDocument's to the collection. If \a addWatcher is true (the default),
the files are added to a file system watcher that notifies the file manager the files are added to a file system watcher that notifies the file manager
about file changes. about file changes.
@@ -362,7 +360,6 @@ static void dump()
*/ */
/*! /*!
\fn void DocumentManager::renamedFile(const QString &from, const QString &to)
\brief Tells the file manager that a file has been renamed on disk from within Qt Creator. \brief Tells the file manager that a file has been renamed on disk from within Qt Creator.
Needs to be called right after the actual renaming on disk (i.e. before the file system Needs to be called right after the actual renaming on disk (i.e. before the file system
@@ -406,8 +403,6 @@ void DocumentManager::fileNameChanged(const QString &oldName, const QString &new
} }
/*! /*!
\fn bool DocumentManager::addFile(IDocument *document, bool addWatcher)
Adds a IDocument object to the collection. If \a addWatcher is true (the default), Adds a IDocument object to the collection. If \a addWatcher is true (the default),
the file is added to a file system watcher that notifies the file manager the file is added to a file system watcher that notifies the file manager
about file changes. about file changes.
@@ -426,8 +421,6 @@ void DocumentManager::documentDestroyed(QObject *obj)
} }
/*! /*!
\fn bool DocumentManager::removeFile(IDocument *document)
Removes a IDocument object from the collection. Removes a IDocument object from the collection.
Returns true if the file specified by \a document had the addWatcher argument to addDocument() set. Returns true if the file specified by \a document had the addWatcher argument to addDocument() set.
@@ -466,7 +459,6 @@ void DocumentManager::checkForNewFileName()
} }
/*! /*!
\fn QString DocumentManager::fixFileName(const QString &fileName, FixMode fixmode)
Returns a guaranteed cleaned path in native form. If the file exists, Returns a guaranteed cleaned path in native form. If the file exists,
it will either be a cleaned absolute file path (fixmode == KeepLinks), or it will either be a cleaned absolute file path (fixmode == KeepLinks), or
a cleaned canonical file path (fixmode == ResolveLinks). a cleaned canonical file path (fixmode == ResolveLinks).
@@ -490,8 +482,6 @@ QString DocumentManager::fixFileName(const QString &fileName, FixMode fixmode)
} }
/*! /*!
\fn QList<IDocument*> DocumentManager::modifiedFiles() const
Returns the list of IDocument's that have been modified. Returns the list of IDocument's that have been modified.
*/ */
QList<IDocument *> DocumentManager::modifiedDocuments() QList<IDocument *> DocumentManager::modifiedDocuments()
@@ -512,8 +502,6 @@ QList<IDocument *> DocumentManager::modifiedDocuments()
} }
/*! /*!
\fn void DocumentManager::expectFileChange(const QString &fileName)
Any subsequent change to \a fileName is treated as a expected file change. Any subsequent change to \a fileName is treated as a expected file change.
\see DocumentManager::unexpectFileChange(const QString &fileName) \see DocumentManager::unexpectFileChange(const QString &fileName)
@@ -538,8 +526,6 @@ static void updateExpectedState(const QString &fileName)
} }
/*! /*!
\fn void DocumentManager::unexpectFileChange(const QString &fileName)
Any change to \a fileName are unexpected again. Any change to \a fileName are unexpected again.
\see DocumentManager::expectFileChange(const QString &fileName) \see DocumentManager::expectFileChange(const QString &fileName)
@@ -562,8 +548,6 @@ void DocumentManager::unexpectFileChange(const QString &fileName)
} }
/*! /*!
\fn QList<IDocument*> DocumentManager::saveModifiedFilesSilently(const QList<IDocument*> &documents)
Tries to save the files listed in \a documents. The \a cancelled argument is set to true Tries to save the files listed in \a documents. The \a cancelled argument is set to true
if the user cancelled the dialog. Returns the files that could not be saved. If the files if the user cancelled the dialog. Returns the files that could not be saved. If the files
listed in documents have no write permissions an additional dialog will be prompted to listed in documents have no write permissions an additional dialog will be prompted to
@@ -575,8 +559,6 @@ QList<IDocument *> DocumentManager::saveModifiedDocumentsSilently(const QList<ID
} }
/*! /*!
\fn QList<IDocument*> DocumentManager::saveModifiedFiles(const QList<IDocument *> &documents, bool *cancelled, const QString &message, const QString &alwaysSaveMessage, bool *alwaysSave)
Asks the user whether to save the files listed in \a documents . Asks the user whether to save the files listed in \a documents .
Opens a dialog with the given \a message, and a additional Opens a dialog with the given \a message, and a additional
text that should be used to ask if the user wants to enabled automatic save text that should be used to ask if the user wants to enabled automatic save
@@ -758,8 +740,6 @@ QString DocumentManager::getSaveFileNameWithExtension(const QString &title, cons
} }
/*! /*!
\fn QString DocumentManager::getSaveAsFileName(IDocument *document, const QString &filter, QString *selectedFilter)
Asks the user for a new file name (Save File As) for /arg document. Asks the user for a new file name (Save File As) for /arg document.
*/ */
QString DocumentManager::getSaveAsFileName(const IDocument *document, const QString &filter, QString *selectedFilter) QString DocumentManager::getSaveAsFileName(const IDocument *document, const QString &filter, QString *selectedFilter)
@@ -794,10 +774,6 @@ QString DocumentManager::getSaveAsFileName(const IDocument *document, const QStr
} }
/*! /*!
\fn QStringList DocumentManager::getOpenFileNames(const QString &filters,
const QString pathIn,
QString *selectedFilter)
Asks the user for a set of file names to be opened. The \a filters Asks the user for a set of file names to be opened. The \a filters
and \a selectedFilter parameters is interpreted like in and \a selectedFilter parameters is interpreted like in
QFileDialog::getOpenFileNames(), \a pathIn specifies a path to open the dialog QFileDialog::getOpenFileNames(), \a pathIn specifies a path to open the dialog
@@ -1078,8 +1054,6 @@ void DocumentManager::syncWithEditor(const QList<Core::IContext *> &context)
} }
/*! /*!
\fn void DocumentManager::addToRecentFiles(const QString &fileName, const QString &editorId)
Adds the \a fileName to the list of recent files. Associates the file to Adds the \a fileName to the list of recent files. Associates the file to
be reopened with an editor of the given \a editorId, if possible. be reopened with an editor of the given \a editorId, if possible.
\a editorId defaults to the empty id, which means to let the system figure out \a editorId defaults to the empty id, which means to let the system figure out
@@ -1103,8 +1077,6 @@ void DocumentManager::addToRecentFiles(const QString &fileName, const Id &editor
} }
/*! /*!
\fn void DocumentManager::clearRecentFiles()
Clears the list of recent files. Should only be called by Clears the list of recent files. Should only be called by
the core plugin when the user chooses to clear it. the core plugin when the user chooses to clear it.
*/ */
@@ -1114,8 +1086,6 @@ void DocumentManager::clearRecentFiles()
} }
/*! /*!
\fn QStringList DocumentManager::recentFiles() const
Returns the list of recent files. Returns the list of recent files.
*/ */
QList<DocumentManager::RecentFile> DocumentManager::recentFiles() QList<DocumentManager::RecentFile> DocumentManager::recentFiles()

5
src/plugins/coreplugin/editormanager/iexternaleditor.cpp
View File

@@ -42,11 +42,6 @@
\internal \internal
*/ */
/*!
\fn IExternalEditor::~IExternalEditor()
\internal
*/
/*! /*!
\fn QStringList IExternalEditor::mimeTypes() const \fn QStringList IExternalEditor::mimeTypes() const
Returns the mime type the editor supports Returns the mime type the editor supports

6
src/plugins/coreplugin/featureprovider.cpp
View File

@@ -60,7 +60,7 @@
*/ */
/*! /*!
\fn FeatureProvider::Features availableFeatures() const; \fn FetureSet IFeatureProvider::availableFeatures(const QString &platform) const
Returns available features provided by this manager. Returns available features provided by this manager.
\sa FeatureProvider::Features \sa FeatureProvider::Features
*/ */
@@ -96,13 +96,13 @@
/*! /*!
\fn bool Features::~contains(const Feature &feature)() \fn bool FeatureSet::contains(const Feature &feature) const
\returns true if the \param features is available. \returns true if the \param features is available.
*/ */
/*! /*!
\fn bool Features::~contains(const Features &features)() \fn bool FeatureSet::contains(const FeatureSet &features) const
\returns true if all \param features are available. \returns true if all \param features are available.
*/ */

71
src/plugins/coreplugin/icore.cpp
View File

@@ -57,7 +57,8 @@
/*! /*!
\fn void ICore::showNewItemDialog(const QString &title, \fn void ICore::showNewItemDialog(const QString &title,
const QList<IWizard *> &wizards, const QList<IWizard *> &wizards,
const QString &defaultLocation = QString()) const QString &defaultLocation = QString(),
const QVariantMap &extraVariables = QVariantMap())
\brief Opens a dialog where the user can choose from a set of \a wizards that \brief Opens a dialog where the user can choose from a set of \a wizards that
create new files/classes/projects. create new files/classes/projects.
@@ -70,9 +71,7 @@
*/ */
/*! /*!
\fn bool ICore::showOptionsDialog(const QString &group = QString(), \fn bool ICore::showOptionsDialog(Id group, Id page, QWidget *parent = 0);
const QString &page = QString(),
QWidget *parent = 0)
\brief Opens the application options/preferences dialog with preselected \brief Opens the application options/preferences dialog with preselected
\a page in a specified \a group. \a page in a specified \a group.
@@ -82,9 +81,9 @@
/*! /*!
\fn bool ICore::showWarningWithOptions(const QString &title, const QString &text, \fn bool ICore::showWarningWithOptions(const QString &title, const QString &text,
const QString &details = QString(), const QString &details = QString(),
const QString &settingsCategory = QString(), Id settingsCategory = Id(),
const QString &settingsId = QString(), Id settingsId = Id(),
QWidget *parent = 0); QWidget *parent = 0)
\brief Show a warning message with a button that opens a settings page. \brief Show a warning message with a button that opens a settings page.
@@ -94,22 +93,21 @@
/*! /*!
\fn ActionManager *ICore::actionManager() const \fn ActionManager *ICore::actionManager()
\brief Returns the application's action manager. \obsolete
The action manager is responsible for registration of menus and Use \c ActionManager::actionManager() directly.
menu items and keyboard shortcuts.
*/ */
/*! /*!
\fn DocumentManager *ICore::fileManager() const \fn DocumentManager *ICore::documentManager()
\brief Returns the application's file manager. \obsolete
The file manager keeps track of files for changes outside the application. Use \c DocumentManager::documentManager() directly.
*/ */
/*! /*!
\fn MessageManager *ICore::messageManager() const \fn MessageManager *ICore::messageManager()
\brief Returns the application's message manager. \brief Returns the application's message manager.
The message manager is the interface to the "General" output pane for The message manager is the interface to the "General" output pane for
@@ -117,7 +115,7 @@
*/ */
/*! /*!
\fn EditorManager *ICore::editorManager() const \fn EditorManager *ICore::editorManager()
\brief Returns the application's editor manager. \brief Returns the application's editor manager.
The editor manager handles all editor related tasks like opening The editor manager handles all editor related tasks like opening
@@ -126,7 +124,7 @@
*/ */
/*! /*!
\fn ProgressManager *ICore::progressManager() const \fn ProgressManager *ICore::progressManager()
\brief Returns the application's progress manager. \brief Returns the application's progress manager.
Use the progress manager to register a concurrent task to Use the progress manager to register a concurrent task to
@@ -134,21 +132,19 @@
*/ */
/*! /*!
\fn ScriptManager *ICore::scriptManager() const \fn ScriptManager *ICore::scriptManager()
\internal \internal
*/ */
/*! /*!
\fn VariableManager *ICore::variableManager() const \fn VariableManager *ICore::variableManager()
\brief Returns the application's variable manager. \obsolete
The variable manager is used to register application wide string variables Use \c VariableManager::variableManager() directly.
like \c MY_PROJECT_DIR such that strings like \c{somecommand ${MY_PROJECT_DIR}/sub}
can be resolved/expanded from anywhere in the application.
*/ */
/*! /*!
\fn VcsManager *ICore::vcsManager() const \fn VcsManager *ICore::vcsManager()
\brief Returns the application's vcs manager. \brief Returns the application's vcs manager.
The vcs manager can be used to e.g. retrieve information about The vcs manager can be used to e.g. retrieve information about
@@ -159,24 +155,21 @@
*/ */
/*! /*!
\fn ModeManager *ICore::modeManager() const \fn ModeManager *ICore::modeManager()
\brief Returns the application's mode manager. \obsolete
The mode manager handles everything related to the instances of IMode Use \c ModeManager::modeManager() directly.
that were added to the plugin manager's object pool as well as their
buttons and the tool bar with the round buttons in the lower left
corner of Qt Creator.
*/ */
/*! /*!
\fn MimeDatabase *ICore::mimeDatabase() const \fn MimeDatabase *ICore::mimeDatabase()
\brief Returns the application's mime database. \brief Returns the application's mime database.
Use the mime database to manage mime types. Use the mime database to manage mime types.
*/ */
/*! /*!
\fn QSettings *ICore::settings(QSettings::Scope scope = QSettings::UserScope) const \fn QSettings *ICore::settings(QSettings::Scope scope = QSettings::UserScope)
\brief Returns the application's main settings object. \brief Returns the application's main settings object.
You can use it to retrieve or set application wide settings You can use it to retrieve or set application wide settings
@@ -194,7 +187,7 @@
*/ */
/*! /*!
\fn SettingsDatabase *ICore::settingsDatabase() const \fn SettingsDatabase *ICore::settingsDatabase()
\brief Returns the application's settings database. \brief Returns the application's settings database.
The settings database is meant as an alternative to the regular settings The settings database is meant as an alternative to the regular settings
@@ -205,7 +198,7 @@
*/ */
/*! /*!
\fn QPrinter *ICore::printer() const \fn QPrinter *ICore::printer()
\brief Returns the application's printer object. \brief Returns the application's printer object.
Always use this printer object for printing, so the different parts of the Always use this printer object for printing, so the different parts of the
@@ -213,7 +206,7 @@
*/ */
/*! /*!
\fn QString ICore::resourcePath() const \fn QString ICore::resourcePath()
\brief Returns the absolute path that is used for resources like \brief Returns the absolute path that is used for resources like
project templates and the debugger macros. project templates and the debugger macros.
@@ -223,7 +216,7 @@
/*! /*!
\fn QString ICore::userResourcePath() const \fn QString ICore::userResourcePath()
\brief Returns the absolute path in the users directory that is used for \brief Returns the absolute path in the users directory that is used for
resources like project templates. resources like project templates.
@@ -232,14 +225,14 @@
*/ */
/*! /*!
\fn QMainWindow *ICore::mainWindow() const \fn QWidget *ICore::mainWindow()
\brief Returns the main application window. \brief Returns the main application window.
For use as dialog parent etc. For use as dialog parent etc.
*/ */
/*! /*!
\fn IContext *ICore::currentContextObject() const \fn IContext *ICore::currentContextObject()
\brief Returns the context object of the current main context. \brief Returns the context object of the current main context.
\sa ICore::updateAdditionalContexts() \sa ICore::updateAdditionalContexts()
@@ -294,7 +287,7 @@
*/ */
/*! /*!
\fn ICore::ICore() \fn ICore::ICore(Internal::MainWindow *mw)
\internal \internal
*/ */

2
src/plugins/coreplugin/id.cpp
View File

@@ -134,7 +134,7 @@ static int theId(const QByteArray &ba)
} }
/*! /*!
\fn Core::Id(int uid) \fn Core::Id::Id(int uid)
\brief Constructs an id given a UID. \brief Constructs an id given a UID.

2
src/plugins/debugger/cdb/cdbparsehelpers.cpp
View File

@@ -458,7 +458,7 @@ QDebug operator<<(QDebug s, const WinException &e)
} }
/*! /*!
\fn DisassemblerLines parseCdbDisassembler(const QList<QByteArray> &a) \fn DisassemblerLines Debugger::Internal::parseCdbDisassembler(const QList<QByteArray> &a)
\brief Parse CDB disassembler output into DisassemblerLines (with helpers) \brief Parse CDB disassembler output into DisassemblerLines (with helpers)

2
src/plugins/find/ifindfilter.cpp
View File

@@ -201,7 +201,7 @@
*/ */
/*! /*!
\fn void IFindFilter::changed() \fn void IFindFilter::enabledChanged(bool enabled)
\brief Signals that the enabled state of this find filter has changed. \brief Signals that the enabled state of this find filter has changed.
*/ */

28
src/plugins/find/searchresultwindow.cpp
View File

@@ -265,7 +265,6 @@ using namespace Find::Internal;
SearchResultWindow *SearchResultWindow::m_instance = 0; SearchResultWindow *SearchResultWindow::m_instance = 0;
/*! /*!
\fn SearchResultWindow::SearchResultWindow()
\internal \internal
*/ */
SearchResultWindow::SearchResultWindow(QWidget *newSearchPanel) SearchResultWindow::SearchResultWindow(QWidget *newSearchPanel)
@@ -305,7 +304,6 @@ SearchResultWindow::SearchResultWindow(QWidget *newSearchPanel)
} }
/*! /*!
\fn SearchResultWindow::~SearchResultWindow()
\internal \internal
*/ */
SearchResultWindow::~SearchResultWindow() SearchResultWindow::~SearchResultWindow()
@@ -318,7 +316,6 @@ SearchResultWindow::~SearchResultWindow()
} }
/*! /*!
\fn SearchResultWindow *SearchResultWindow::instance()
\brief Returns the single shared instance of the Search Results window. \brief Returns the single shared instance of the Search Results window.
*/ */
SearchResultWindow *SearchResultWindow::instance() SearchResultWindow *SearchResultWindow::instance()
@@ -327,7 +324,6 @@ SearchResultWindow *SearchResultWindow::instance()
} }
/*! /*!
\fn void SearchResultWindow::visibilityChanged(bool)
\internal \internal
*/ */
void SearchResultWindow::visibilityChanged(bool visible) void SearchResultWindow::visibilityChanged(bool visible)
@@ -337,7 +333,6 @@ void SearchResultWindow::visibilityChanged(bool visible)
} }
/*! /*!
\fn QWidget *SearchResultWindow::outputWidget(QWidget *)
\internal \internal
*/ */
QWidget *SearchResultWindow::outputWidget(QWidget *) QWidget *SearchResultWindow::outputWidget(QWidget *)
@@ -346,7 +341,6 @@ QWidget *SearchResultWindow::outputWidget(QWidget *)
} }
/*! /*!
\fn QList<QWidget*> SearchResultWindow::toolBarWidgets() const
\internal \internal
*/ */
QList<QWidget*> SearchResultWindow::toolBarWidgets() const QList<QWidget*> SearchResultWindow::toolBarWidgets() const
@@ -413,7 +407,6 @@ SearchResult *SearchResultWindow::startNewSearch(const QString &label,
} }
/*! /*!
\fn void SearchResultWindow::clearContents()
\brief Clears the current contents in the search result window. \brief Clears the current contents in the search result window.
*/ */
void SearchResultWindow::clearContents() void SearchResultWindow::clearContents()
@@ -434,7 +427,6 @@ void SearchResultWindow::clearContents()
} }
/*! /*!
\fn bool SearchResultWindow::hasFocus()
\internal \internal
*/ */
bool SearchResultWindow::hasFocus() const bool SearchResultWindow::hasFocus() const
@@ -443,7 +435,6 @@ bool SearchResultWindow::hasFocus() const
} }
/*! /*!
\fn bool SearchResultWindow::canFocus()
\internal \internal
*/ */
bool SearchResultWindow::canFocus() const bool SearchResultWindow::canFocus() const
@@ -454,7 +445,6 @@ bool SearchResultWindow::canFocus() const
} }
/*! /*!
\fn void SearchResultWindow::setFocus()
\internal \internal
*/ */
void SearchResultWindow::setFocus() void SearchResultWindow::setFocus()
@@ -466,7 +456,6 @@ void SearchResultWindow::setFocus()
} }
/*! /*!
\fn void SearchResultWindow::setTextEditorFont(const QFont &font)
\internal \internal
*/ */
void SearchResultWindow::setTextEditorFont(const QFont &font, void SearchResultWindow::setTextEditorFont(const QFont &font,
@@ -497,7 +486,6 @@ void SearchResultWindow::openNewSearchPanel()
} }
/*! /*!
\fn void SearchResultWindow::handleExpandCollapseToolButton(bool checked)
\internal \internal
*/ */
void SearchResultWindow::handleExpandCollapseToolButton(bool checked) void SearchResultWindow::handleExpandCollapseToolButton(bool checked)
@@ -515,7 +503,6 @@ void SearchResultWindow::handleExpandCollapseToolButton(bool checked)
} }
/*! /*!
\fn void SearchResultWindow::readSettings()
\internal \internal
*/ */
void SearchResultWindow::readSettings() void SearchResultWindow::readSettings()
@@ -529,7 +516,6 @@ void SearchResultWindow::readSettings()
} }
/*! /*!
\fn void SearchResultWindow::writeSettings()
\internal \internal
*/ */
void SearchResultWindow::writeSettings() void SearchResultWindow::writeSettings()
@@ -543,7 +529,6 @@ void SearchResultWindow::writeSettings()
} }
/*! /*!
\fn int SearchResultWindow::priorityInStatusBar() const
\internal \internal
*/ */
int SearchResultWindow::priorityInStatusBar() const int SearchResultWindow::priorityInStatusBar() const
@@ -552,7 +537,6 @@ int SearchResultWindow::priorityInStatusBar() const
} }
/*! /*!
\fn bool SearchResultWindow::canNext()
\internal \internal
*/ */
bool SearchResultWindow::canNext() const bool SearchResultWindow::canNext() const
@@ -563,7 +547,6 @@ bool SearchResultWindow::canNext() const
} }
/*! /*!
\fn bool SearchResultWindow::canPrevious()
\internal \internal
*/ */
bool SearchResultWindow::canPrevious() const bool SearchResultWindow::canPrevious() const
@@ -572,7 +555,6 @@ bool SearchResultWindow::canPrevious() const
} }
/*! /*!
\fn void SearchResultWindow::goToNext()
\internal \internal
*/ */
void SearchResultWindow::goToNext() void SearchResultWindow::goToNext()
@@ -583,7 +565,6 @@ void SearchResultWindow::goToNext()
} }
/*! /*!
\fn void SearchResultWindow::goToPrev()
\internal \internal
*/ */
void SearchResultWindow::goToPrev() void SearchResultWindow::goToPrev()
@@ -594,7 +575,6 @@ void SearchResultWindow::goToPrev()
} }
/*! /*!
\fn bool SearchResultWindow::canNavigate()
\internal \internal
*/ */
bool SearchResultWindow::canNavigate() const bool SearchResultWindow::canNavigate() const
@@ -603,7 +583,6 @@ bool SearchResultWindow::canNavigate() const
} }
/*! /*!
\fn SearchResult::SearchResult(SearchResultWidget *widget)
\internal \internal
*/ */
SearchResult::SearchResult(SearchResultWidget *widget) SearchResult::SearchResult(SearchResultWidget *widget)
@@ -624,7 +603,6 @@ SearchResult::SearchResult(SearchResultWidget *widget)
} }
/*! /*!
\fn void SearchResult::setUserData(const QVariant &data)
\brief Attach some random \a data to this search, that you can use later. \brief Attach some random \a data to this search, that you can use later.
\sa userData() \sa userData()
@@ -635,7 +613,6 @@ void SearchResult::setUserData(const QVariant &data)
} }
/*! /*!
\fn void SearchResult::userData()
\brief Return the data that was attached to this search by calling setUserData(). \brief Return the data that was attached to this search by calling setUserData().
\sa setUserData() \sa setUserData()
@@ -646,7 +623,6 @@ QVariant SearchResult::userData() const
} }
/*! /*!
\fn QString SearchResult::textToReplace() const
\brief Returns the text that should replace the text in search results. \brief Returns the text that should replace the text in search results.
*/ */
QString SearchResult::textToReplace() const QString SearchResult::textToReplace() const
@@ -665,7 +641,6 @@ void SearchResult::setSearchAgainSupported(bool supported)
} }
/*! /*!
\fn void SearchResult::addResult(const QString &fileName, int lineNumber, const QString &rowText, int searchTermStart, int searchTermLength, const QVariant &userData)
\brief Adds a single result line to the search results. \brief Adds a single result line to the search results.
The \a fileName, \a lineNumber and \a rowText are shown in the result line. The \a fileName, \a lineNumber and \a rowText are shown in the result line.
@@ -685,7 +660,6 @@ void SearchResult::addResult(const QString &fileName, int lineNumber, const QStr
} }
/*! /*!
\fn void SearchResult::addResults(const QList<SearchResultItem> &items, SearchResult::AddMode mode)
\brief Adds all of the given search result \a items to the search \brief Adds all of the given search result \a items to the search
results window. results window.
@@ -698,7 +672,6 @@ void SearchResult::addResults(const QList<SearchResultItem> &items, AddMode mode
} }
/*! /*!
\fn void SearchResult::finishSearch()
\brief Notifies the search result window that the current search \brief Notifies the search result window that the current search
has finished, and the UI should reflect that. has finished, and the UI should reflect that.
*/ */
@@ -708,7 +681,6 @@ void SearchResult::finishSearch(bool canceled)
} }
/*! /*!
\fn void SearchResult::setTextToReplace(const QString &textToReplace)
\brief Sets the value in the UI element that allows the user to type \brief Sets the value in the UI element that allows the user to type
the text that should replace text in search results to \a textToReplace. the text that should replace text in search results to \a textToReplace.
*/ */

6
src/plugins/projectexplorer/buildstep.cpp
View File

@@ -101,15 +101,15 @@
*/ */
/*! /*!
\fn void addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format, \fn void ProjectExplorer::BuildStep::addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format,
ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting) ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting = DoAppendNewline) const
The string is added to the generated output, usually in the output window. The string is added to the generated output, usually in the output window.
It should be in plain text, with the format in the parameter. It should be in plain text, with the format in the parameter.
*/ */
/*! /*!
\fn void ProjectExplorer::BuildStep::cancel() const \fn void ProjectExplorer::BuildStep::cancel()
This function needs to be reimplemented only for BuildSteps that return false from \sa runInGuiThread. This function needs to be reimplemented only for BuildSteps that return false from \sa runInGuiThread.
*/ */

10
src/plugins/projectexplorer/devicesupport/idevice.cpp
View File

@@ -96,7 +96,7 @@
*/ */
/*! /*!
* \fn ProjectExplorer::IDeviceWidget *ProjectExplorer::IDevice::createWidget() const * \fn ProjectExplorer::IDeviceWidget *ProjectExplorer::IDevice::createWidget()
* \brief Creates a widget that displays device information not part of the IDevice base class. * \brief Creates a widget that displays device information not part of the IDevice base class.
* The widget can also be used to let the user change these attributes. * The widget can also be used to let the user change these attributes.
*/ */
@@ -108,13 +108,13 @@
*/ */
/*! /*!
* \fn QString ProjectExplorer::IDevice::displayNameForActionId(const QString &actionId) const * \fn QString ProjectExplorer::IDevice::displayNameForActionId(Core::Id actionId) const
* \brief A human-readable string for the given id. Will be displayed on a button which, * \brief A human-readable string for the given id. Will be displayed on a button which,
* when clicked, starts the respective action. * when clicked, starts the respective action.
*/ */
/*! /*!
* \fn void ProjectExplorer::IDevice::executeAction(Core::Id actionId, QWidget *parent) * \fn void ProjectExplorer::IDevice::executeAction(Core::Id actionId, QWidget *parent) const
* \brief Executes the respective action. This is typically done via some sort of dialog or * \brief Executes the respective action. This is typically done via some sort of dialog or
* wizard, so a parent widget argument is provided. * wizard, so a parent widget argument is provided.
*/ */
@@ -125,14 +125,14 @@
*/ */
/*! /*!
* \fn void fromMap(const QVariantMap &map) * \fn void ProjectExplorer::IDevice::fromMap(const QVariantMap &map)
* \brief Restores a device object from a serialized state as written by \c toMap(). * \brief Restores a device object from a serialized state as written by \c toMap().
* If subclasses override this to restore additional state, they must call the base class * If subclasses override this to restore additional state, they must call the base class
* implementation. * implementation.
*/ */
/*! /*!
* \fn QVariantMap toMap() const * \fn ProjectExplorer::IDevice::toMap() const
* \brief Serializes a device object, e.g. to save it to a file. * \brief Serializes a device object, e.g. to save it to a file.
* If subclasses override this to save additional state, they must call the base class * If subclasses override this to save additional state, they must call the base class
* implementation. * implementation.

6
src/plugins/projectexplorer/runconfiguration.cpp
View File

@@ -298,7 +298,7 @@ Utils::OutputFormatter *RunConfiguration::createOutputFormatter() const
*/ */
/*! /*!
\fn QString ProjectExplorer::IRunConfigurationFactory::displayNameForId(const QString &id) const \fn QString ProjectExplorer::IRunConfigurationFactory::displayNameForId(const Core::Id id) const
\brief Used to translate the types to names to display to the user. \brief Used to translate the types to names to display to the user.
*/ */
@@ -375,7 +375,7 @@ QList<IRunConfigurationFactory *> IRunConfigurationFactory::find(Target *parent)
*/ */
/*! /*!
\fn IRunConfigurationAspect *ProjectExplorer::IRunControlFactory::createRunConfigurationAspect() \fn IRunConfigurationAspect *ProjectExplorer::IRunControlFactory::createRunConfigurationAspect(RunConfiguration *rc)
\brief Return an IRunConfigurationAspect to carry options for RunControls this factory can create. \brief Return an IRunConfigurationAspect to carry options for RunControls this factory can create.
If no extra options are required it is allowed to return null like the default implementation does. If no extra options are required it is allowed to return null like the default implementation does.
@@ -384,7 +384,7 @@ QList<IRunConfigurationFactory *> IRunConfigurationFactory::find(Target *parent)
*/ */
/*! /*!
\fn RunConfigWidget *ProjectExplorer::IRunControlFactory::createConfigurationWidget(RunConfiguration *runConfiguration) \fn RunConfigWidget *ProjectExplorer::IRunConfigurationAspect::createConfigurationWidget()
\brief Return a widget used to configure this runner. Ownership is transferred to the caller. \brief Return a widget used to configure this runner. Ownership is transferred to the caller.

4
src/plugins/texteditor/codeassist/iassistinterface.cpp
View File

@@ -75,13 +75,13 @@ IAssistInterface::~IAssistInterface()
*/ */
/*! /*!
\fn const Core::IDocument *TextEditor::IAssistInterface::file() const \fn QString TextEditor::IAssistInterface::fileName() const
Returns the file associated. Returns the file associated.
*/ */
/*! /*!
\fn QTextDocument *TextEditor::IAssistInterface::document() const \fn QTextDocument *TextEditor::IAssistInterface::textDocument() const
Returns the document. Returns the document.
*/ */

2
src/plugins/texteditor/codeassist/iassistproposalwidget.cpp
View File

@@ -79,7 +79,7 @@ IAssistProposalWidget::~IAssistProposalWidget()
*/ */
/*! /*!
\fn void TextEditor::IAssistProposalWidget::setModel(IAssistModel *model) \fn void TextEditor::IAssistProposalWidget::setModel(IAssistProposalModel *model)
Sets the model. Sets the model.
*/ */

2
src/plugins/texteditor/codeassist/iassistprovider.cpp
View File

@@ -50,7 +50,7 @@ using namespace TextEditor;
*/ */
/*! /*!
\fn bool TextEditor::IAssistProvider::supportsEditor(const QString &editorId) const \fn bool TextEditor::IAssistProvider::supportsEditor(const Core::Id &editorId) const
Returns whether this provider supports the editor which has the give \a editorId. Returns whether this provider supports the editor which has the give \a editorId.
*/ */

2
src/plugins/vcsbase/checkoutprogresswizardpage.cpp
View File

@@ -36,7 +36,7 @@
#include <QApplication> #include <QApplication>
/*! /*!
\class VcsBase::CheckoutProgressWizardPage \class VcsBase::Internal::CheckoutProgressWizardPage
\brief Page showing the progress of an initial project checkout. Turns complete when the job \brief Page showing the progress of an initial project checkout. Turns complete when the job
succeeds. succeeds.