From ac26d3bab96493283d490df7f4db9b94652dcdba Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Fri, 21 Feb 2020 14:47:59 +0100 Subject: [PATCH] Doc: Add Core:: namespace to \fn commands To suppress QDoc warnings. Task-number: QTCREATORBUG-23620 Change-Id: I4e5c633e7a0066f892f3247c28dac055557e68da Reviewed-by: Eike Ziller --- doc/qtcreatordev/src/qtcreator-module.qdoc | 7 ++- .../actionmanager/actioncontainer.cpp | 40 ++++++++-------- .../actionmanager/actionmanager.cpp | 6 +-- .../coreplugin/actionmanager/command.cpp | 48 +++++++++---------- .../coreplugin/dialogs/ioptionspage.cpp | 18 +++---- src/plugins/coreplugin/find/basetextfind.cpp | 4 +- src/plugins/coreplugin/find/ifindfilter.cpp | 28 +++++------ src/plugins/coreplugin/find/ifindsupport.cpp | 30 ++++++------ .../coreplugin/find/searchresultwindow.cpp | 20 ++++---- .../coreplugin/locator/ilocatorfilter.cpp | 10 ++-- 10 files changed, 107 insertions(+), 104 deletions(-) diff --git a/doc/qtcreatordev/src/qtcreator-module.qdoc b/doc/qtcreatordev/src/qtcreator-module.qdoc index 4d57ca4a57c..2a4ec2d03de 100644 --- a/doc/qtcreatordev/src/qtcreator-module.qdoc +++ b/doc/qtcreatordev/src/qtcreator-module.qdoc @@ -77,8 +77,10 @@ \row \li \l{qtcreatorcdbext} \li Windows CDB debugger extension + \endomit \endtable + \section1 Plugins As already mentioned, \QC is basically only a plugin loader framework @@ -98,9 +100,10 @@ most important ones. This plugin also contains classes necessary to hook into the - \l{Locator} as well as support for searching text in arbitrary - widgets. + \l{Core::ILocatorFilter}{Locator} as well as support for + searching text in arbitrary widgets. + \omit \row \li \l{ProjectExplorer} \li The project explorer plugin. Provides base classes for project diff --git a/src/plugins/coreplugin/actionmanager/actioncontainer.cpp b/src/plugins/coreplugin/actionmanager/actioncontainer.cpp index 7737128f46e..63ea5a66e5b 100644 --- a/src/plugins/coreplugin/actionmanager/actioncontainer.cpp +++ b/src/plugins/coreplugin/actionmanager/actioncontainer.cpp @@ -64,13 +64,13 @@ namespace Core { You can specify whether the menu represented by this action container should be automatically disabled or hidden whenever it only contains disabled items - and submenus by setting the corresponding - \l{ActionContainer::setOnAllDisabledBehavior()}{OnAllDisabledBehavior}. The default is - ActionContainer::Disable for menus, and ActionContainer::Show for menu bars. + and submenus by setting the corresponding \l setOnAllDisabledBehavior(). The + default is ActionContainer::Disable for menus, and ActionContainer::Show for + menu bars. */ /*! - \enum ActionContainer::OnAllDisabledBehavior + \enum Core::ActionContainer::OnAllDisabledBehavior Defines what happens when the represented menu is empty or contains only disabled or invisible items. \value Disable @@ -82,7 +82,7 @@ namespace Core { */ /*! - \fn ActionContainer::setOnAllDisabledBehavior(OnAllDisabledBehavior behavior) + \fn Core::ActionContainer::setOnAllDisabledBehavior(OnAllDisabledBehavior behavior) Defines the \a behavior of the menu represented by this action container for the case whenever it only contains disabled items and submenus. The default is ActionContainer::Disable for menus, and ActionContainer::Show for menu bars. @@ -91,39 +91,39 @@ namespace Core { */ /*! - \fn ActionContainer::onAllDisabledBehavior() const + \fn Core::ActionContainer::onAllDisabledBehavior() const Returns the behavior of the menu represented by this action container for the case whenever it only contains disabled items and submenus. The default is ActionContainer::Disable for menus, and ActionContainer::Show for menu bars. - \sa ActionContainer::OnAllDisabledBehavior - \sa ActionContainer::setOnAllDisabledBehavior() + \sa OnAllDisabledBehavior + \sa setOnAllDisabledBehavior() */ /*! - \fn int ActionContainer::id() const + \fn int Core::ActionContainer::id() const \internal */ /*! - \fn QMenu *ActionContainer::menu() const + \fn QMenu *Core::ActionContainer::menu() const Returns the QMenu instance that is represented by this action container, or 0 if this action container represents a menu bar. */ /*! - \fn QMenuBar *ActionContainer::menuBar() const + \fn QMenuBar *Core::ActionContainer::menuBar() const Returns the QMenuBar instance that is represented by this action container, or 0 if this action container represents a menu. */ /*! - \fn QAction *ActionContainer::insertLocation(Id group) const + \fn QAction *Core::ActionContainer::insertLocation(Core::Id group) const Returns an action representing the \a group, that could be used with \c{QWidget::insertAction}. */ /*! - \fn void ActionContainer::appendGroup(Id group) + \fn void Core::ActionContainer::appendGroup(Core::Id group) Adds \a group to the action container. Use groups to segment your action container into logical parts. You can add @@ -133,7 +133,7 @@ namespace Core { */ /*! - \fn void ActionContainer::addAction(Command *action, Id group = Id()) + \fn void Core::ActionContainer::addAction(Core::Command *action, Core::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() @@ -141,7 +141,7 @@ namespace Core { */ /*! - \fn void ActionContainer::addMenu(ActionContainer *menu, Id group = Id()) + \fn void Core::ActionContainer::addMenu(Core::ActionContainer *menu, Core::Id group = Core::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() @@ -149,7 +149,7 @@ namespace Core { */ /*! - \fn void ActionContainer::addMenu(ActionContainer *before, ActionContainer *menu) + \fn void Core::ActionContainer::addMenu(Core::ActionContainer *before, Core::ActionContainer *menu) Add \a menu as a submenu to this action container before the menu specified by \a before. \sa appendGroup() @@ -157,7 +157,7 @@ namespace Core { */ /*! - \fn ActionContainer::clear() + \fn Core::ActionContainer::clear() Clears this menu and submenus from all actions and submenus. However, does does not destroy the submenus and commands, just removes them from their @@ -165,20 +165,20 @@ namespace Core { */ /*! - \fn ActionContainer::insertGroup(Id before, Id group) + \fn Core::ActionContainer::insertGroup(Core::Id before, Core::Id group) Inserts \a group to the action container before the group specified by \a before. */ /*! - \fn virtual Utils::TouchBar *ActionContainer::touchBar() const + \fn virtual Utils::TouchBar *Core::ActionContainer::touchBar() const Returns the touch bar that is represented by this action container. */ /*! - \fn ActionContainer::addSeparator(const Context &context, Id group, QAction **outSeparator) + \fn Core::ActionContainer::addSeparator(const Core::Context &context, Core::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. Returns the created separator diff --git a/src/plugins/coreplugin/actionmanager/actionmanager.cpp b/src/plugins/coreplugin/actionmanager/actionmanager.cpp index 0f25fc4a192..449a0040bcb 100644 --- a/src/plugins/coreplugin/actionmanager/actionmanager.cpp +++ b/src/plugins/coreplugin/actionmanager/actionmanager.cpp @@ -70,7 +70,7 @@ using namespace Core::Internal; All actions that are registered with the same Id (but different context lists) are considered to be overloads of the same command, represented by an instance - of the Command class. + of the Core::Command class. Exactly only one of the registered actions with the same ID is active at any time. Which action this is, is defined by the context list that the actions were registered with: @@ -141,13 +141,13 @@ using namespace Core::Internal; */ /*! - \fn void ActionManager::commandListChanged() + \fn void Core::ActionManager::commandListChanged() Emitted when the command list has changed. */ /*! - \fn void ActionManager::commandAdded(Core::Id id) + \fn void Core::ActionManager::commandAdded(Core::Id id) Emitted when a command (with the \a id) is added. */ diff --git a/src/plugins/coreplugin/actionmanager/command.cpp b/src/plugins/coreplugin/actionmanager/command.cpp index 2d2eba652db..cd801c1ec2f 100644 --- a/src/plugins/coreplugin/actionmanager/command.cpp +++ b/src/plugins/coreplugin/actionmanager/command.cpp @@ -67,7 +67,7 @@ */ /*! - \enum Command::CommandAttribute + \enum Core::Command::CommandAttribute This enum defines how the user visible action is updated when the active action changes. The default is to update the enabled and visible state, and to disable the user visible action when there is no active action. @@ -84,37 +84,37 @@ */ /*! - \fn void Command::setDefaultKeySequence(const QKeySequence &key) + \fn void Core::Command::setDefaultKeySequence(const QKeySequence &key) Sets the default keyboard shortcut that can be used to activate this command to \a key. This is used if the user didn't customize the shortcut, or resets the shortcut to the default one. */ /*! - \fn void Command::defaultKeySequence() const + \fn void Core::Command::defaultKeySequence() const Returns the default keyboard shortcut that can be used to activate this command. \sa setDefaultKeySequence() */ /*! - \fn void Command::keySequenceChanged() + \fn void Core::Command::keySequenceChanged() Sent when the keyboard shortcut assigned to this Command changes, e.g. when the user sets it in the keyboard shortcut settings dialog. */ /*! - \fn QKeySequence Command::keySequence() const + \fn QKeySequence Core::Command::keySequence() const Returns the current keyboard shortcut assigned to this Command. \sa defaultKeySequence() */ /*! - \fn void Command::setKeySequence(const QKeySequence &key) + \fn void Core::Command::setKeySequence(const QKeySequence &key) \internal */ /*! - \fn void Command::setDescription(const QString &text) + \fn void Core::Command::setDescription(const QString &text) Sets the \a text that is used to represent the Command in the keyboard shortcut settings dialog. If you do not set this, the current text from the user visible action is taken (which @@ -122,24 +122,24 @@ */ /*! - \fn QString Command::description() const + \fn QString Core::Command::description() const Returns the text that is used to present this Command to the user. \sa setDescription() */ /*! - \fn int Command::id() const + \fn int Core::Command::id() const \internal */ /*! - \fn QString Command::stringWithAppendedShortcut(const QString &string) const + \fn QString Core::Command::stringWithAppendedShortcut(const QString &string) const Returns the \a string with an appended representation of the keyboard shortcut that is currently assigned to this Command. */ /*! - \fn QAction *Command::action() const + \fn QAction *Core::Command::action() const Returns the user visible action for this Command. If the Command represents a shortcut, it returns null. Use this action to put it on e.g. tool buttons. The action @@ -152,13 +152,13 @@ */ /*! - \fn Context Command::context() const + \fn Core::Context Core::Command::context() const Returns the context for this command. */ /*! - \fn void Command::setAttribute(CommandAttribute attribute) + \fn void Core::Command::setAttribute(Core::Command::CommandAttribute attribute) Adds \a attribute to the attributes of this Command. \sa CommandAttribute \sa removeAttribute() @@ -166,14 +166,14 @@ */ /*! - \fn void Command::removeAttribute(CommandAttribute attribute) + \fn void Core::Command::removeAttribute(Core::Command::CommandAttribute attribute) Removes \a attribute from the attributes of this Command. \sa CommandAttribute \sa setAttribute() */ /*! - \fn bool Command::hasAttribute(CommandAttribute attribute) const + \fn bool Core::Command::hasAttribute(Core::Command::CommandAttribute attribute) const Returns whether the Command has the \a attribute set. \sa CommandAttribute \sa removeAttribute() @@ -181,54 +181,54 @@ */ /*! - \fn bool Command::isActive() const + \fn bool Core::Command::isActive() const Returns whether the Command has an active action or shortcut for the current context. */ /*! - \fn bool Command::isScriptable() const + \fn bool Core::Command::isScriptable() const Returns whether the Command is scriptable. A scriptable command can be called from a script without the need for the user to interact with it. */ /*! - \fn bool Command::isScriptable(const Context &) const + \fn bool Core::Command::isScriptable(const Core::Context &) const \internal Returns whether the Command is scriptable. */ /*! - \fn void Command::activeStateChanged() + \fn void Core::Command::activeStateChanged() This signal is emitted when the active state of the command changes. */ /*! - \fn virtual void Command::setTouchBarText(const QString &text) + \fn virtual void Core::Command::setTouchBarText(const QString &text) Sets the text for the action on the touch bar to \a text. */ /*! - \fn virtual QString Command::touchBarText() const + \fn virtual QString Core::Command::touchBarText() const Returns the text for the action on the touch bar. */ /*! - \fn virtual void Command::setTouchBarIcon(const QIcon &icon) + \fn virtual void Core::Command::setTouchBarIcon(const QIcon &icon) Sets the icon for the action on the touch bar to \a icon. */ -/*! \fn virtual QIcon Command::touchBarIcon() const +/*! \fn virtual QIcon Core::Command::touchBarIcon() const Returns the icon for the action on the touch bar. */ -/*! \fn virtual QAction *Command::touchBarAction() const +/*! \fn virtual QAction *Core::Command::touchBarAction() const Adds an action to the touch bar. */ diff --git a/src/plugins/coreplugin/dialogs/ioptionspage.cpp b/src/plugins/coreplugin/dialogs/ioptionspage.cpp index e2d2ea5e9ce..be700875ad4 100644 --- a/src/plugins/coreplugin/dialogs/ioptionspage.cpp +++ b/src/plugins/coreplugin/dialogs/ioptionspage.cpp @@ -62,26 +62,26 @@ using namespace Utils; /*! - \fn Id IOptionsPage::id() const + \fn Core::Id Core::IOptionsPage::id() const Returns a unique identifier for referencing the options page. */ /*! - \fn QString IOptionsPage::displayName() const + \fn QString Core::IOptionsPage::displayName() const Returns the translated display name of the options page. */ /*! - \fn Id IOptionsPage::category() const + \fn Core::Id Core::IOptionsPage::category() const Returns the unique id for the category that the options page should be displayed in. This id is used for sorting the list on the left side of the \uicontrol Options dialog. */ /*! - \fn QString IOptionsPage::displayCategory() const + \fn QString Core::IOptionsPage::displayCategory() const Returns the translated category name of the options page. This name is displayed in the list on the left side of the \uicontrol Options dialog. @@ -168,31 +168,31 @@ void Core::IOptionsPage::setCategoryIconPath(const QString &categoryIconPath) } /*! - \fn void IOptionsPage::setId(Id id) + \fn void Core::IOptionsPage::setId(Core::Id id) Sets the \a id of the options page. */ /*! - \fn void IOptionsPage::setDisplayName(const QString &displayName) + \fn void Core::IOptionsPage::setDisplayName(const QString &displayName) Sets \a displayName as the display name of the options page. */ /*! - \fn void IOptionsPage::setCategory(Id category) + \fn void Core::IOptionsPage::setCategory(Core::Id category) Uses \a category to sort the options pages. */ /*! - \fn void IOptionsPage::setDisplayCategory(const QString &displayCategory) + \fn void Core::IOptionsPage::setDisplayCategory(const QString &displayCategory) Sets \a displayCategory as the display category of the options page. */ /*! - \fn void IOptionsPage::setCategoryIcon(const Utils::Icon &categoryIcon) + \fn void Core::IOptionsPage::setCategoryIcon(const Utils::Icon &categoryIcon) Sets \a categoryIcon as the category icon of the options page. */ diff --git a/src/plugins/coreplugin/find/basetextfind.cpp b/src/plugins/coreplugin/find/basetextfind.cpp index 2d3cb7de0b5..71bc7687e8a 100644 --- a/src/plugins/coreplugin/find/basetextfind.cpp +++ b/src/plugins/coreplugin/find/basetextfind.cpp @@ -92,7 +92,7 @@ BaseTextFindPrivate::BaseTextFindPrivate(QPlainTextEdit *editor) */ /*! - \fn void BaseTextFind::findScopeChanged(const QTextCursor &start, + \fn void Core::BaseTextFind::findScopeChanged(const QTextCursor &start, const QTextCursor &end, int verticalBlockSelectionFirstColumn, int verticalBlockSelectionLastColumn) @@ -104,7 +104,7 @@ BaseTextFindPrivate::BaseTextFindPrivate(QPlainTextEdit *editor) */ /*! - \fn void BaseTextFind::highlightAllRequested(const QString &txt, Core::FindFlags findFlags) + \fn void Core::BaseTextFind::highlightAllRequested(const QString &txt, Core::FindFlags findFlags) This signal is emitted when the search results for \a txt using the given \a findFlags should be highlighted in the editor widget. diff --git a/src/plugins/coreplugin/find/ifindfilter.cpp b/src/plugins/coreplugin/find/ifindfilter.cpp index fef203a1f8c..b61d935e607 100644 --- a/src/plugins/coreplugin/find/ifindfilter.cpp +++ b/src/plugins/coreplugin/find/ifindfilter.cpp @@ -99,14 +99,14 @@ /*! - \fn QString IFindFilter::id() const + \fn QString Core::IFindFilter::id() const Returns the unique string identifier for this find filter. Usually should be something like "MyPlugin.MyFindFilter". */ /*! - \fn QString IFindFilter::displayName() const + \fn QString Core::IFindFilter::displayName() const Returns the name of the find filter or scope as presented to the user. This is the name that appears in the scope selection combo box, for example. @@ -115,7 +115,7 @@ */ /*! - \fn bool IFindFilter::isEnabled() const + \fn bool Core::IFindFilter::isEnabled() const Returns whether the user should be able to select this find filter at the moment. @@ -127,14 +127,14 @@ */ /*! - \fn bool IFindFilter::isValid() const + \fn bool Core::IFindFilter::isValid() const Returns whether the find filter is valid. \sa validChanged() */ /*! - \fn bool IFindFilter::isReplaceSupported() const + \fn bool Core::IFindFilter::isReplaceSupported() const Returns whether the find filter supports search and replace. The default value is false, override this function to return \c true, if @@ -142,7 +142,7 @@ */ /*! - \fn bool IFindFilter::showSearchTermInput() const + \fn bool Core::IFindFilter::showSearchTermInput() const Returns whether the find filter wants to show the search term line edit. The default value is \c true, override this function to return \c false, if @@ -150,7 +150,7 @@ */ /*! - \fn void IFindFilter::findAll(const QString &txt, FindFlags findFlags) + \fn void Core::IFindFilter::findAll(const QString &txt, Core::FindFlags findFlags) This function is called when the user selected this find scope and initiated a search. @@ -167,7 +167,7 @@ */ /*! - \fn void IFindFilter::replaceAll(const QString &txt, FindFlags findFlags) + \fn void Core::IFindFilter::replaceAll(const QString &txt, Core::FindFlags findFlags) Override this function if you want to support search and replace. This function is called when the user selected this find scope and @@ -187,7 +187,7 @@ */ /*! - \fn QWidget *IFindFilter::createConfigWidget() + \fn QWidget *Core::IFindFilter::createConfigWidget() Returns a widget that contains additional controls for options for this find filter. @@ -196,32 +196,32 @@ */ /*! - \fn void IFindFilter::writeSettings(QSettings *settings) + \fn void Core::IFindFilter::writeSettings(QSettings *settings) Called at shutdown to write the state of the additional options for this find filter to the \a settings. */ /*! - \fn void IFindFilter::readSettings(QSettings *settings) + \fn void Core::IFindFilter::readSettings(QSettings *settings) Called at startup to read the state of the additional options for this find filter from the \a settings. */ /*! - \fn void IFindFilter::enabledChanged(bool enabled) + \fn void Core::IFindFilter::enabledChanged(bool enabled) This signal is emitted when the \a enabled state of this find filter changes. */ /*! - \fn void IFindFilter::validChanged(bool valid) + \fn void Core::IFindFilter::validChanged(bool valid) This signal is emitted when the \a valid state of this find filter changes. */ /*! - \fn void IFindFilter::displayNameChanged() + \fn void Core::IFindFilter::displayNameChanged() This signal is emitted when the display name of this find filter changes. */ diff --git a/src/plugins/coreplugin/find/ifindsupport.cpp b/src/plugins/coreplugin/find/ifindsupport.cpp index f36bea2146d..ffd671e94be 100644 --- a/src/plugins/coreplugin/find/ifindsupport.cpp +++ b/src/plugins/coreplugin/find/ifindsupport.cpp @@ -40,7 +40,7 @@ using namespace Core; */ /*! - \enum IFindSupport::Result + \enum Core::IFindSupport::Result This enum holds whether the search term was found within the search scope using the find flags. @@ -50,22 +50,22 @@ using namespace Core; */ /*! - \fn IFindSupport::IFindSupport() + \fn Core::IFindSupport::IFindSupport() \internal */ /*! - \fn IFindSupport::~IFindSupport() + \fn Core::IFindSupport::~IFindSupport() \internal */ /*! - \fn bool IFindSupport::supportsReplace() const + \fn bool Core::IFindSupport::supportsReplace() const Returns whether the find filter supports search and replace. */ /*! - \fn FindFlags IFindSupport::supportedFindFlags() const + \fn Core::FindFlags Core::IFindSupport::supportedFindFlags() const Returns the find flags, such as whole words or regular expressions, that this find filter supports. @@ -78,52 +78,52 @@ using namespace Core; */ /*! - \fn void IFindSupport::resetIncrementalSearch() + \fn void Core::IFindSupport::resetIncrementalSearch() Resets incremental search to start position. */ /*! - \fn void IFindSupport::clearHighlights() + \fn void Core::IFindSupport::clearHighlights() Clears highlighting of search results in the searched widget. */ /*! - \fn QString IFindSupport::currentFindString() const + \fn QString Core::IFindSupport::currentFindString() const Returns the current search string. */ /*! - \fn QString IFindSupport::completedFindString() const + \fn QString Core::IFindSupport::completedFindString() const Returns the complete search string. */ /*! - \fn void IFindSupport::highlightAll(const QString &txt, FindFlags findFlags) + \fn void Core::IFindSupport::highlightAll(const QString &txt, Core::FindFlags findFlags) Highlights all search hits for \a txt when using \a findFlags. */ /*! - \fn Result IFindSupport::findIncremental(const QString &txt, FindFlags findFlags) + \fn Core::IFindSupport::Result Core::IFindSupport::findIncremental(const QString &txt, Core::FindFlags findFlags) Performs an incremental search of the search term \a txt using \a findFlags. */ /*! - \fn Result IFindSupport::findStep(const QString &txt, FindFlags findFlags) + \fn Core::IFindSupport::Result Core::IFindSupport::findStep(const QString &txt, Core::FindFlags findFlags) Searches for \a txt using \a findFlags. */ /*! - \fn void IFindSupport::defineFindScope() + \fn void Core::IFindSupport::defineFindScope() Defines the find scope. */ /*! - \fn void IFindSupport::clearFindScope() + \fn void Core::IFindSupport::clearFindScope() Clears the find scope. */ /*! - \fn void IFindSupport::changed() + \fn void Core::IFindSupport::changed() This signal is emitted when the search changes. */ diff --git a/src/plugins/coreplugin/find/searchresultwindow.cpp b/src/plugins/coreplugin/find/searchresultwindow.cpp index a9895f720c8..8f973dbe4c4 100644 --- a/src/plugins/coreplugin/find/searchresultwindow.cpp +++ b/src/plugins/coreplugin/find/searchresultwindow.cpp @@ -270,13 +270,13 @@ using namespace Core::Internal; */ /*! - \fn void SearchResult::activated(const Core::SearchResultItem &item) + \fn void Core::SearchResult::activated(const Core::SearchResultItem &item) Indicates that the user activated the search result \a item by double-clicking it, for example. */ /*! - \fn void SearchResult::replaceButtonClicked(const QString &replaceText, + \fn void Core::SearchResult::replaceButtonClicked(const QString &replaceText, const QList &checkedItems, bool preserveCase) @@ -303,36 +303,36 @@ using namespace Core::Internal; */ /*! - \fn void SearchResult::cancelled() + \fn void Core::SearchResult::cancelled() This signal is emitted if the user cancels the search. */ /*! - \fn void SearchResult::countChanged(int count) + \fn void Core::SearchResult::countChanged(int count) This signal is emitted when the number of search hits changes to \a count. */ /*! - \fn void SearchResult::paused(bool paused) + \fn void Core::SearchResult::paused(bool paused) This signal is emitted when the search status is set to \a paused. */ /*! - \fn void SearchResult::requestEnabledCheck() + \fn void Core::SearchResult::requestEnabledCheck() This signal is emitted when the enabled status of search results is requested. */ /*! - \fn void SearchResult::searchAgainRequested() + \fn void Core::SearchResult::searchAgainRequested() This signal is emitted when the \uicontrol {Search Again} button is selected. */ /*! - \fn void SearchResult::visibilityChanged(bool visible) + \fn void Core::SearchResult::visibilityChanged(bool visible) This signal is emitted when the visibility of the search results changes to \a visible. @@ -372,12 +372,12 @@ using namespace Core::Internal; */ /*! - \fn QString SearchResultWindow::displayName() const + \fn QString Core::SearchResultWindow::displayName() const \internal */ /*! - \enum SearchResultWindow::PreserveCaseMode + \enum Core::SearchResultWindow::PreserveCaseMode This enum type specifies whether a search and replace should preserve the case of the replaced strings: diff --git a/src/plugins/coreplugin/locator/ilocatorfilter.cpp b/src/plugins/coreplugin/locator/ilocatorfilter.cpp index 1d1b8213f8d..e0df3e242d9 100644 --- a/src/plugins/coreplugin/locator/ilocatorfilter.cpp +++ b/src/plugins/coreplugin/locator/ilocatorfilter.cpp @@ -455,7 +455,7 @@ void ILocatorFilter::setConfigurable(bool configurable) } /*! - \fn QList ILocatorFilter::matchesFor(QFutureInterface &future, const QString &entry) + \fn QList Core::ILocatorFilter::matchesFor(QFutureInterface &future, const QString &entry) Returns the list of results of this filter for the search term \a entry. This is run in a separate thread, but is guaranteed to only run in a single @@ -471,7 +471,7 @@ void ILocatorFilter::setConfigurable(bool configurable) */ /*! - \fn void ILocatorFilter::accept(LocatorFilterEntry selection, QString *newText, int *selectionStart, int *selectionLength) const + \fn void Core::ILocatorFilter::accept(Core::LocatorFilterEntry selection, QString *newText, int *selectionStart, int *selectionLength) const Called with the entry specified by \a selection when the user activates it in the result list. @@ -480,7 +480,7 @@ void ILocatorFilter::setConfigurable(bool configurable) */ /*! - \fn void ILocatorFilter::refresh(QFutureInterface &future) + \fn void Core::ILocatorFilter::refresh(QFutureInterface &future) Refreshes cached data asynchronously. @@ -488,7 +488,7 @@ void ILocatorFilter::setConfigurable(bool configurable) */ /*! - \enum ILocatorFilter::Priority + \enum Core::ILocatorFilter::Priority This enum value holds the priority that is used for ordering the results when multiple filters are used. @@ -505,7 +505,7 @@ void ILocatorFilter::setConfigurable(bool configurable) */ /*! - \enum ILocatorFilter::MatchLevel + \enum Core::ILocatorFilter::MatchLevel This enum value holds the level for ordering the results based on how well they match the search criteria.