diff --git a/src/libs/cplusplus/PreprocessorClient.cpp b/src/libs/cplusplus/PreprocessorClient.cpp index f40e6d92c5c..7cd95e78103 100644 --- a/src/libs/cplusplus/PreprocessorClient.cpp +++ b/src/libs/cplusplus/PreprocessorClient.cpp @@ -43,7 +43,7 @@ using namespace CPlusPlus; */ /*! - \fn void Client::passedMacroDefinitionCheck(unsigned offset, const Macro ¯o) + \fn void Client::passedMacroDefinitionCheck(unsigned offset, unsigned line, const Macro ¯o) Called when the preprocessor checks whether a macro is defined or not and the 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 result is negative. @@ -61,10 +61,12 @@ using namespace CPlusPlus; */ /*! - \fn void Client::startExpandingMacro(unsigned offset, const Macro ¯o, const QByteArray &originalText, bool inCondition = false, const QVector &actuals = QVector()) - - Called when starting to expand a macro. The parameter \a inCondition indicates whether the - expansion is happening inside a preprocessor conditional. + \fn void Client::startExpandingMacro(unsigned offset, + unsigned line, + const Macro ¯o, + const QVector &actuals + = QVector()) + Called when starting to expand a macro. \sa stopExpandingMacro() */ diff --git a/src/libs/extensionsystem/pluginmanager.cpp b/src/libs/extensionsystem/pluginmanager.cpp index 69b51317933..e2e8d124e8c 100644 --- a/src/libs/extensionsystem/pluginmanager.cpp +++ b/src/libs/extensionsystem/pluginmanager.cpp @@ -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. This method is aware of Aggregation::Aggregate, i.e. it uses the Aggregation::query methods instead of qobject_cast to @@ -225,7 +226,7 @@ enum { debugLeaks = 0 }; */ /*! - \fn QList PluginManager::getObjects() const + \fn QList PluginManager::getObjects() Retrieve all objects of a given type from the object pool. This method is aware of Aggregation::Aggregate, i.e. it uses 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; /*! - \fn PluginManager *PluginManager::instance() Get the unique plugin manager 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. */ PluginManager::PluginManager() @@ -264,7 +263,6 @@ PluginManager::PluginManager() } /*! - \fn PluginManager::~PluginManager() \internal */ 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. 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. @@ -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. \sa PluginManager::addObject() */ @@ -301,7 +297,6 @@ void PluginManager::removeObject(QObject *obj) } /*! - \fn QList PluginManager::allObjects() const Retrieve the list of all objects in the pool, unfiltered. Usually clients do not need to call this. \sa PluginManager::getObject() @@ -313,7 +308,6 @@ QList PluginManager::allObjects() } /*! - \fn void PluginManager::loadPlugins() Tries to load all the plugins that were previously found when setting the plugin search paths. The plugin specs of the 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. Most useful to call after loadPlugins(). */ @@ -342,7 +335,6 @@ bool PluginManager::hasError() } /*! - \fn void PluginManager::shutdown() Shuts down and deletes all plugins. */ 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. \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 looks for plugin descriptions. All given \a paths and their sub directory trees 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 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. The default is "xml". 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 arguments). Typically, this will be the list of files to open. */ @@ -449,7 +436,6 @@ QStringList PluginManager::arguments() } /*! - \fn QList PluginManager::plugins() const List of all plugin specifications that have been found in the plugin search paths. This list is valid directly after the setPluginPaths() call. The plugin specifications contain the information from the plugins' xml description files @@ -469,8 +455,6 @@ QHash PluginManager::pluginCollections() } /*! - \fn QString PluginManager::serializedArguments() const - Serialize plugin options and arguments for sending in a single string via QtSingleApplication: ":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 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 &appOptions, QMap *foundAppOptions, QString *errorString) Takes the list of command line options in \a args and parses them. The plugin manager itself might process some options itself directly (-noload ), and 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. */ @@ -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. */ @@ -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. */ @@ -747,7 +722,6 @@ void PluginManager::startTests() } /*! - * \fn bool PluginManager::runningTests() const * \internal */ bool PluginManager::testRunRequested() @@ -756,7 +730,6 @@ bool PluginManager::testRunRequested() } /*! - * \fn QString PluginManager::testDataDirectory() const * \internal */ 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. */ @@ -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. */ QList PluginManager::loadQueue() @@ -796,7 +765,6 @@ QList PluginManager::loadQueue() //============PluginManagerPrivate=========== /*! - \fn PluginSpec *PluginManagerPrivate::createSpec() \internal */ PluginSpec *PluginManagerPrivate::createSpec() @@ -805,7 +773,6 @@ PluginSpec *PluginManagerPrivate::createSpec() } /*! - \fn void PluginManagerPrivate::setSettings(QSettings *settings) \internal */ void PluginManagerPrivate::setSettings(QSettings *s) @@ -830,7 +797,6 @@ void PluginManagerPrivate::setGlobalSettings(QSettings *s) } /*! - \fn PluginSpecPrivate *PluginManagerPrivate::privateSpec(PluginSpec *spec) \internal */ PluginSpecPrivate *PluginManagerPrivate::privateSpec(PluginSpec *spec) @@ -859,7 +825,6 @@ void PluginManagerPrivate::nextDelayedInitialize() } /*! - \fn PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager) \internal */ PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager) : @@ -876,7 +841,6 @@ PluginManagerPrivate::PluginManagerPrivate(PluginManager *pluginManager) : /*! - \fn PluginManagerPrivate::~PluginManagerPrivate() \internal */ PluginManagerPrivate::~PluginManagerPrivate() @@ -886,7 +850,6 @@ PluginManagerPrivate::~PluginManagerPrivate() } /*! - \fn void PluginManagerPrivate::writeSettings() \internal */ void PluginManagerPrivate::writeSettings() @@ -907,7 +870,6 @@ void PluginManagerPrivate::writeSettings() } /*! - \fn void PluginManagerPrivate::readSettings() \internal */ void PluginManagerPrivate::readSettings() @@ -921,7 +883,6 @@ void PluginManagerPrivate::readSettings() } /*! - \fn void PluginManagerPrivate::stopAll() \internal */ void PluginManagerPrivate::stopAll() @@ -938,7 +899,6 @@ void PluginManagerPrivate::stopAll() } /*! - \fn void PluginManagerPrivate::deleteAll() \internal */ void PluginManagerPrivate::deleteAll() @@ -952,7 +912,6 @@ void PluginManagerPrivate::deleteAll() } /*! - \fn void PluginManagerPrivate::addObject(QObject *obj) \internal */ void PluginManagerPrivate::addObject(QObject *obj) @@ -984,7 +943,6 @@ void PluginManagerPrivate::addObject(QObject *obj) } /*! - \fn void PluginManagerPrivate::removeObject(QObject *obj) \internal */ void PluginManagerPrivate::removeObject(QObject *obj) @@ -1008,7 +966,6 @@ void PluginManagerPrivate::removeObject(QObject *obj) } /*! - \fn void PluginManagerPrivate::loadPlugins() \internal */ void PluginManagerPrivate::loadPlugins() @@ -1039,7 +996,6 @@ void PluginManagerPrivate::loadPlugins() } /*! - \fn void PluginManagerPrivate::shutdown() \internal */ void PluginManagerPrivate::shutdown() @@ -1055,7 +1011,6 @@ void PluginManagerPrivate::shutdown() } /*! - \fn void PluginManagerPrivate::asyncShutdownFinished() \internal */ void PluginManagerPrivate::asyncShutdownFinished() @@ -1068,7 +1023,6 @@ void PluginManagerPrivate::asyncShutdownFinished() } /*! - \fn void PluginManagerPrivate::loadQueue() \internal */ QList PluginManagerPrivate::loadQueue() @@ -1082,7 +1036,6 @@ QList PluginManagerPrivate::loadQueue() } /*! - \fn bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList &queue, QList &circularityCheckQueue) \internal */ bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList &queue, @@ -1125,7 +1078,6 @@ bool PluginManagerPrivate::loadQueue(PluginSpec *spec, QList &queu } /*! - \fn void PluginManagerPrivate::loadPlugin(PluginSpec *spec, PluginSpec::State destState) \internal */ 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 */ void PluginManagerPrivate::setPluginPaths(const QStringList &paths) @@ -1203,7 +1154,6 @@ void PluginManagerPrivate::setPluginPaths(const QStringList &paths) } /*! - \fn void PluginManagerPrivate::readPluginPaths() \internal */ 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. \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. \sa addObject() */ diff --git a/src/libs/extensionsystem/pluginview.cpp b/src/libs/extensionsystem/pluginview.cpp index 10f8c2484c8..5469a2fce9a 100644 --- a/src/libs/extensionsystem/pluginview.cpp +++ b/src/libs/extensionsystem/pluginview.cpp @@ -70,7 +70,6 @@ Q_DECLARE_METATYPE(ExtensionSystem::PluginSpec*) Q_DECLARE_METATYPE(ExtensionSystem::PluginCollection*) /*! - \fn PluginView::PluginView(PluginManager *manager, QWidget *parent) Constructs a PluginView that gets the list of plugins from the given plugin \a manager with a given \a parent widget. */ @@ -105,7 +104,6 @@ PluginView::PluginView(QWidget *parent) } /*! - \fn PluginView::~PluginView() \internal */ PluginView::~PluginView() @@ -114,7 +112,6 @@ PluginView::~PluginView() } /*! - \fn PluginSpec *PluginView::currentPlugin() const Returns the current selection in the list of plugins. */ PluginSpec *PluginView::currentPlugin() const diff --git a/src/libs/qmljs/persistenttrie.cpp b/src/libs/qmljs/persistenttrie.cpp index 75db9b5e8b9..15bed733fe2 100644 --- a/src/libs/qmljs/persistenttrie.cpp +++ b/src/libs/qmljs/persistenttrie.cpp @@ -642,8 +642,6 @@ Trie Trie::replaceF(const QHash &replacements) const } /*! - \fn int matchStrength(const QString &searchStr, const QString &str) - Returns a number defining how well the serachStr matches str. 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 */ QStringList matchStrengthSort(const QString &searchStr, QStringList &res) diff --git a/src/plugins/coreplugin/actionmanager/actioncontainer.cpp b/src/plugins/coreplugin/actionmanager/actioncontainer.cpp index 1f60a533d98..9562e73bdfd 100644 --- a/src/plugins/coreplugin/actionmanager/actioncontainer.cpp +++ b/src/plugins/coreplugin/actionmanager/actioncontainer.cpp @@ -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, 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 you can segment your action container into logical parts and add actions and 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 last item of the specified \a group. \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 last item of the specified \a group. \sa appendGroup() \sa addAction() */ -/*! - \fn ActionContainer::~ActionContainer() - \internal -*/ - // ---------- 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 * for a given \a context. The created separator action is returned through \a outSeparator. * diff --git a/src/plugins/coreplugin/actionmanager/command.cpp b/src/plugins/coreplugin/actionmanager/command.cpp index b49eb5274e2..08e0f9cf8ea 100644 --- a/src/plugins/coreplugin/actionmanager/command.cpp +++ b/src/plugins/coreplugin/actionmanager/command.cpp @@ -200,11 +200,6 @@ interact with it. */ -/*! - \fn Command::~Command() - \internal -*/ - using namespace Core; using namespace Core::Internal; diff --git a/src/plugins/coreplugin/basefilewizard.cpp b/src/plugins/coreplugin/basefilewizard.cpp index cd6bbc1441a..cb8f8bc4c91 100644 --- a/src/plugins/coreplugin/basefilewizard.cpp +++ b/src/plugins/coreplugin/basefilewizard.cpp @@ -559,8 +559,7 @@ Core::IWizard::WizardFlags BaseFileWizard::flags() const /*! \fn virtual QWizard *Core::BaseFileWizard::createWizardDialog(QWidget *parent, - const QString &defaultPath, - const WizardPageList &extensionPages) const = 0 + const WizardDialogParameters &wizardDialogParameters) const \brief Implement to create the wizard dialog on the parent, adding the extension pages. */ diff --git a/src/plugins/coreplugin/dialogs/iwizard.cpp b/src/plugins/coreplugin/dialogs/iwizard.cpp index a7c905d6655..9fdb675fba5 100644 --- a/src/plugins/coreplugin/dialogs/iwizard.cpp +++ b/src/plugins/coreplugin/dialogs/iwizard.cpp @@ -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 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 diff --git a/src/plugins/coreplugin/documentmanager.cpp b/src/plugins/coreplugin/documentmanager.cpp index cee77d0225a..4d13e4cf49e 100644 --- a/src/plugins/coreplugin/documentmanager.cpp +++ b/src/plugins/coreplugin/documentmanager.cpp @@ -273,8 +273,6 @@ static void addFileInfo(IDocument *document) } /*! - \fn bool DocumentManager::addFiles(const QList &documents, bool addWatcher) - 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 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. 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), the file is added to a file system watcher that notifies the file manager 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. 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, it will either be a cleaned absolute file path (fixmode == KeepLinks), or a cleaned canonical file path (fixmode == ResolveLinks). @@ -490,8 +482,6 @@ QString DocumentManager::fixFileName(const QString &fileName, FixMode fixmode) } /*! - \fn QList DocumentManager::modifiedFiles() const - Returns the list of IDocument's that have been modified. */ QList DocumentManager::modifiedDocuments() @@ -512,8 +502,6 @@ QList DocumentManager::modifiedDocuments() } /*! - \fn void DocumentManager::expectFileChange(const QString &fileName) - Any subsequent change to \a fileName is treated as a expected file change. \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. \see DocumentManager::expectFileChange(const QString &fileName) @@ -562,8 +548,6 @@ void DocumentManager::unexpectFileChange(const QString &fileName) } /*! - \fn QList DocumentManager::saveModifiedFilesSilently(const QList &documents) - 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 listed in documents have no write permissions an additional dialog will be prompted to @@ -575,8 +559,6 @@ QList DocumentManager::saveModifiedDocumentsSilently(const QList DocumentManager::saveModifiedFiles(const QList &documents, bool *cancelled, const QString &message, const QString &alwaysSaveMessage, bool *alwaysSave) - Asks the user whether to save the files listed in \a documents . 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 @@ -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. */ 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 and \a selectedFilter parameters is interpreted like in QFileDialog::getOpenFileNames(), \a pathIn specifies a path to open the dialog @@ -1078,8 +1054,6 @@ void DocumentManager::syncWithEditor(const QList &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 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 @@ -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 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. */ QList DocumentManager::recentFiles() diff --git a/src/plugins/coreplugin/editormanager/iexternaleditor.cpp b/src/plugins/coreplugin/editormanager/iexternaleditor.cpp index c1bd9ceeb36..2189afb9d3d 100644 --- a/src/plugins/coreplugin/editormanager/iexternaleditor.cpp +++ b/src/plugins/coreplugin/editormanager/iexternaleditor.cpp @@ -42,11 +42,6 @@ \internal */ -/*! - \fn IExternalEditor::~IExternalEditor() - \internal -*/ - /*! \fn QStringList IExternalEditor::mimeTypes() const Returns the mime type the editor supports diff --git a/src/plugins/coreplugin/featureprovider.cpp b/src/plugins/coreplugin/featureprovider.cpp index f0b1bde4f5a..5403491fbde 100644 --- a/src/plugins/coreplugin/featureprovider.cpp +++ b/src/plugins/coreplugin/featureprovider.cpp @@ -60,7 +60,7 @@ */ /*! - \fn FeatureProvider::Features availableFeatures() const; + \fn FetureSet IFeatureProvider::availableFeatures(const QString &platform) const Returns available features provided by this manager. \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. */ /*! - \fn bool Features::~contains(const Features &features)() + \fn bool FeatureSet::contains(const FeatureSet &features) const \returns true if all \param features are available. */ diff --git a/src/plugins/coreplugin/icore.cpp b/src/plugins/coreplugin/icore.cpp index 32a74650f18..7110485e2fa 100644 --- a/src/plugins/coreplugin/icore.cpp +++ b/src/plugins/coreplugin/icore.cpp @@ -57,7 +57,8 @@ /*! \fn void ICore::showNewItemDialog(const QString &title, const QList &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 create new files/classes/projects. @@ -70,9 +71,7 @@ */ /*! - \fn bool ICore::showOptionsDialog(const QString &group = QString(), - const QString &page = QString(), - QWidget *parent = 0) + \fn bool ICore::showOptionsDialog(Id group, Id page, QWidget *parent = 0); \brief Opens the application options/preferences dialog with preselected \a page in a specified \a group. @@ -82,9 +81,9 @@ /*! \fn bool ICore::showWarningWithOptions(const QString &title, const QString &text, const QString &details = QString(), - const QString &settingsCategory = QString(), - const QString &settingsId = QString(), - QWidget *parent = 0); + Id settingsCategory = Id(), + Id settingsId = Id(), + QWidget *parent = 0) \brief Show a warning message with a button that opens a settings page. @@ -94,22 +93,21 @@ /*! - \fn ActionManager *ICore::actionManager() const - \brief Returns the application's action manager. + \fn ActionManager *ICore::actionManager() + \obsolete - The action manager is responsible for registration of menus and - menu items and keyboard shortcuts. + Use \c ActionManager::actionManager() directly. */ /*! - \fn DocumentManager *ICore::fileManager() const - \brief Returns the application's file manager. + \fn DocumentManager *ICore::documentManager() + \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. 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. 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. Use the progress manager to register a concurrent task to @@ -134,21 +132,19 @@ */ /*! - \fn ScriptManager *ICore::scriptManager() const + \fn ScriptManager *ICore::scriptManager() \internal */ /*! - \fn VariableManager *ICore::variableManager() const - \brief Returns the application's variable manager. + \fn VariableManager *ICore::variableManager() + \obsolete - The variable manager is used to register application wide string variables - like \c MY_PROJECT_DIR such that strings like \c{somecommand ${MY_PROJECT_DIR}/sub} - can be resolved/expanded from anywhere in the application. + Use \c VariableManager::variableManager() directly. */ /*! - \fn VcsManager *ICore::vcsManager() const + \fn VcsManager *ICore::vcsManager() \brief Returns the application's vcs manager. The vcs manager can be used to e.g. retrieve information about @@ -159,24 +155,21 @@ */ /*! - \fn ModeManager *ICore::modeManager() const - \brief Returns the application's mode manager. + \fn ModeManager *ICore::modeManager() + \obsolete - The mode manager handles everything related to the instances of IMode - 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. + Use \c ModeManager::modeManager() directly. */ /*! - \fn MimeDatabase *ICore::mimeDatabase() const + \fn MimeDatabase *ICore::mimeDatabase() \brief Returns the application's mime database. 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. 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. 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. 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 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 resources like project templates. @@ -232,14 +225,14 @@ */ /*! - \fn QMainWindow *ICore::mainWindow() const + \fn QWidget *ICore::mainWindow() \brief Returns the main application window. 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. \sa ICore::updateAdditionalContexts() @@ -294,7 +287,7 @@ */ /*! - \fn ICore::ICore() + \fn ICore::ICore(Internal::MainWindow *mw) \internal */ diff --git a/src/plugins/coreplugin/id.cpp b/src/plugins/coreplugin/id.cpp index 57f655ae520..d4950263c0f 100644 --- a/src/plugins/coreplugin/id.cpp +++ b/src/plugins/coreplugin/id.cpp @@ -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. diff --git a/src/plugins/debugger/cdb/cdbparsehelpers.cpp b/src/plugins/debugger/cdb/cdbparsehelpers.cpp index 71e2a5d0ad0..755b3c61ec9 100644 --- a/src/plugins/debugger/cdb/cdbparsehelpers.cpp +++ b/src/plugins/debugger/cdb/cdbparsehelpers.cpp @@ -458,7 +458,7 @@ QDebug operator<<(QDebug s, const WinException &e) } /*! - \fn DisassemblerLines parseCdbDisassembler(const QList &a) + \fn DisassemblerLines Debugger::Internal::parseCdbDisassembler(const QList &a) \brief Parse CDB disassembler output into DisassemblerLines (with helpers) diff --git a/src/plugins/find/ifindfilter.cpp b/src/plugins/find/ifindfilter.cpp index 7e34177becd..96389beb933 100644 --- a/src/plugins/find/ifindfilter.cpp +++ b/src/plugins/find/ifindfilter.cpp @@ -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. */ diff --git a/src/plugins/find/searchresultwindow.cpp b/src/plugins/find/searchresultwindow.cpp index 257f2966fe1..61523af2650 100644 --- a/src/plugins/find/searchresultwindow.cpp +++ b/src/plugins/find/searchresultwindow.cpp @@ -265,7 +265,6 @@ using namespace Find::Internal; SearchResultWindow *SearchResultWindow::m_instance = 0; /*! - \fn SearchResultWindow::SearchResultWindow() \internal */ SearchResultWindow::SearchResultWindow(QWidget *newSearchPanel) @@ -305,7 +304,6 @@ SearchResultWindow::SearchResultWindow(QWidget *newSearchPanel) } /*! - \fn SearchResultWindow::~SearchResultWindow() \internal */ SearchResultWindow::~SearchResultWindow() @@ -318,7 +316,6 @@ SearchResultWindow::~SearchResultWindow() } /*! - \fn SearchResultWindow *SearchResultWindow::instance() \brief Returns the single shared instance of the Search Results window. */ SearchResultWindow *SearchResultWindow::instance() @@ -327,7 +324,6 @@ SearchResultWindow *SearchResultWindow::instance() } /*! - \fn void SearchResultWindow::visibilityChanged(bool) \internal */ void SearchResultWindow::visibilityChanged(bool visible) @@ -337,7 +333,6 @@ void SearchResultWindow::visibilityChanged(bool visible) } /*! - \fn QWidget *SearchResultWindow::outputWidget(QWidget *) \internal */ QWidget *SearchResultWindow::outputWidget(QWidget *) @@ -346,7 +341,6 @@ QWidget *SearchResultWindow::outputWidget(QWidget *) } /*! - \fn QList SearchResultWindow::toolBarWidgets() const \internal */ QList 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. */ void SearchResultWindow::clearContents() @@ -434,7 +427,6 @@ void SearchResultWindow::clearContents() } /*! - \fn bool SearchResultWindow::hasFocus() \internal */ bool SearchResultWindow::hasFocus() const @@ -443,7 +435,6 @@ bool SearchResultWindow::hasFocus() const } /*! - \fn bool SearchResultWindow::canFocus() \internal */ bool SearchResultWindow::canFocus() const @@ -454,7 +445,6 @@ bool SearchResultWindow::canFocus() const } /*! - \fn void SearchResultWindow::setFocus() \internal */ void SearchResultWindow::setFocus() @@ -466,7 +456,6 @@ void SearchResultWindow::setFocus() } /*! - \fn void SearchResultWindow::setTextEditorFont(const QFont &font) \internal */ void SearchResultWindow::setTextEditorFont(const QFont &font, @@ -497,7 +486,6 @@ void SearchResultWindow::openNewSearchPanel() } /*! - \fn void SearchResultWindow::handleExpandCollapseToolButton(bool checked) \internal */ void SearchResultWindow::handleExpandCollapseToolButton(bool checked) @@ -515,7 +503,6 @@ void SearchResultWindow::handleExpandCollapseToolButton(bool checked) } /*! - \fn void SearchResultWindow::readSettings() \internal */ void SearchResultWindow::readSettings() @@ -529,7 +516,6 @@ void SearchResultWindow::readSettings() } /*! - \fn void SearchResultWindow::writeSettings() \internal */ void SearchResultWindow::writeSettings() @@ -543,7 +529,6 @@ void SearchResultWindow::writeSettings() } /*! - \fn int SearchResultWindow::priorityInStatusBar() const \internal */ int SearchResultWindow::priorityInStatusBar() const @@ -552,7 +537,6 @@ int SearchResultWindow::priorityInStatusBar() const } /*! - \fn bool SearchResultWindow::canNext() \internal */ bool SearchResultWindow::canNext() const @@ -563,7 +547,6 @@ bool SearchResultWindow::canNext() const } /*! - \fn bool SearchResultWindow::canPrevious() \internal */ bool SearchResultWindow::canPrevious() const @@ -572,7 +555,6 @@ bool SearchResultWindow::canPrevious() const } /*! - \fn void SearchResultWindow::goToNext() \internal */ void SearchResultWindow::goToNext() @@ -583,7 +565,6 @@ void SearchResultWindow::goToNext() } /*! - \fn void SearchResultWindow::goToPrev() \internal */ void SearchResultWindow::goToPrev() @@ -594,7 +575,6 @@ void SearchResultWindow::goToPrev() } /*! - \fn bool SearchResultWindow::canNavigate() \internal */ bool SearchResultWindow::canNavigate() const @@ -603,7 +583,6 @@ bool SearchResultWindow::canNavigate() const } /*! - \fn SearchResult::SearchResult(SearchResultWidget *widget) \internal */ 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. \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(). \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. */ 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. 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 &items, SearchResult::AddMode mode) \brief Adds all of the given search result \a items to the search results window. @@ -698,7 +672,6 @@ void SearchResult::addResults(const QList &items, AddMode mode } /*! - \fn void SearchResult::finishSearch() \brief Notifies the search result window that the current search 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 the text that should replace text in search results to \a textToReplace. */ diff --git a/src/plugins/projectexplorer/buildstep.cpp b/src/plugins/projectexplorer/buildstep.cpp index 2d42b85429c..5fe313f7680 100644 --- a/src/plugins/projectexplorer/buildstep.cpp +++ b/src/plugins/projectexplorer/buildstep.cpp @@ -101,15 +101,15 @@ */ /*! - \fn void addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format, - ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting) + \fn void ProjectExplorer::BuildStep::addOutput(const QString &string, ProjectExplorer::BuildStep::OutputFormat format, + ProjectExplorer::BuildStep::OutputNewlineSetting newlineSetting = DoAppendNewline) const 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. */ /*! - \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. */ diff --git a/src/plugins/projectexplorer/devicesupport/idevice.cpp b/src/plugins/projectexplorer/devicesupport/idevice.cpp index 2d121ae173b..0d4bae0816f 100644 --- a/src/plugins/projectexplorer/devicesupport/idevice.cpp +++ b/src/plugins/projectexplorer/devicesupport/idevice.cpp @@ -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. * 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, * 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 * 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(). * If subclasses override this to restore additional state, they must call the base class * implementation. */ /*! - * \fn QVariantMap toMap() const + * \fn ProjectExplorer::IDevice::toMap() const * \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 * implementation. diff --git a/src/plugins/projectexplorer/runconfiguration.cpp b/src/plugins/projectexplorer/runconfiguration.cpp index 725d2b1132f..039255a38cf 100644 --- a/src/plugins/projectexplorer/runconfiguration.cpp +++ b/src/plugins/projectexplorer/runconfiguration.cpp @@ -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. */ @@ -375,7 +375,7 @@ QList 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. If no extra options are required it is allowed to return null like the default implementation does. @@ -384,7 +384,7 @@ QList 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. diff --git a/src/plugins/texteditor/codeassist/iassistinterface.cpp b/src/plugins/texteditor/codeassist/iassistinterface.cpp index 269dcaf6525..02f86386cea 100644 --- a/src/plugins/texteditor/codeassist/iassistinterface.cpp +++ b/src/plugins/texteditor/codeassist/iassistinterface.cpp @@ -75,13 +75,13 @@ IAssistInterface::~IAssistInterface() */ /*! - \fn const Core::IDocument *TextEditor::IAssistInterface::file() const + \fn QString TextEditor::IAssistInterface::fileName() const Returns the file associated. */ /*! - \fn QTextDocument *TextEditor::IAssistInterface::document() const + \fn QTextDocument *TextEditor::IAssistInterface::textDocument() const Returns the document. */ diff --git a/src/plugins/texteditor/codeassist/iassistproposalwidget.cpp b/src/plugins/texteditor/codeassist/iassistproposalwidget.cpp index 1524d349e16..6f68661fb2e 100644 --- a/src/plugins/texteditor/codeassist/iassistproposalwidget.cpp +++ b/src/plugins/texteditor/codeassist/iassistproposalwidget.cpp @@ -79,7 +79,7 @@ IAssistProposalWidget::~IAssistProposalWidget() */ /*! - \fn void TextEditor::IAssistProposalWidget::setModel(IAssistModel *model) + \fn void TextEditor::IAssistProposalWidget::setModel(IAssistProposalModel *model) Sets the model. */ diff --git a/src/plugins/texteditor/codeassist/iassistprovider.cpp b/src/plugins/texteditor/codeassist/iassistprovider.cpp index cf7bc5a416e..12aca9f3ce7 100644 --- a/src/plugins/texteditor/codeassist/iassistprovider.cpp +++ b/src/plugins/texteditor/codeassist/iassistprovider.cpp @@ -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. */ diff --git a/src/plugins/vcsbase/checkoutprogresswizardpage.cpp b/src/plugins/vcsbase/checkoutprogresswizardpage.cpp index 4b44a905da7..da8e500bb86 100644 --- a/src/plugins/vcsbase/checkoutprogresswizardpage.cpp +++ b/src/plugins/vcsbase/checkoutprogresswizardpage.cpp @@ -36,7 +36,7 @@ #include /*! - \class VcsBase::CheckoutProgressWizardPage + \class VcsBase::Internal::CheckoutProgressWizardPage \brief Page showing the progress of an initial project checkout. Turns complete when the job succeeds.