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

Doc: Fix QDoc warnings for the API reference

Browse Source 
Change-Id: I3507009756822f3ac795057a37c5f34a6e2bcd10
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2024-05-16 15:22:49 +02:00
parent 450611ddcc
commit 58abfc52e5
3 changed files with 14 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -50,8 +50,9 @@
*/ */
/*! /*!
\fn void ExtensionSystem::PluginView::pluginSettingsChanged(ExtensionSystem::PluginSpec *spec) \fn void ExtensionSystem::PluginView::pluginsChanged(const QSet<ExtensionSystem::PluginSpec *> &spec, bool enabled)
The settings for the plugin list entry corresponding to \a spec changed. The value of \a enabled for the plugin list entry corresponding to \a spec
changed.
*/ */
using namespace Utils; using namespace Utils;

8
src/plugins/coreplugin/find/ifindfilter.cpp
View File

@@ -30,7 +30,7 @@ using namespace Utils;
and \uicontrol {Files in File System} where the user provides a directory and file and \uicontrol {Files in File System} where the user provides a directory and file
patterns to search. patterns to search.
\image qtcreator-search-filesystem.png \image qtcreator-search-reg-exp.webp {Search Results view with search criteria}
To make your find scope available to the user, you need to implement this To make your find scope available to the user, you need to implement this
class, and register an instance of your subclass in the plugin manager. class, and register an instance of your subclass in the plugin manager.
@@ -38,7 +38,7 @@ using namespace Utils;
A common way to present the search results to the user, is to use the A common way to present the search results to the user, is to use the
shared \uicontrol{Search Results} pane. shared \uicontrol{Search Results} pane.
\image qtcreator-search-results.webp {Search Results view} \image qtcreator-search-results-reg-exp.webp {Search Results view with search results}
If you want to implement a find filter that is doing a file based text If you want to implement a find filter that is doing a file based text
search, you should use \l Core::BaseTextFind, which already implements all search, you should use \l Core::BaseTextFind, which already implements all
@@ -178,13 +178,13 @@ using namespace Utils;
*/ */
/*! /*!
\fn void Core::IFindFilter::writeSettings(QSettings *settings) \fn void Core::IFindFilter::writeSettings(Utils::QtcSettings *settings)
Called at shutdown to write the state of the additional options Called at shutdown to write the state of the additional options
for this find filter to the \a settings. for this find filter to the \a settings.
*/ */
/*! /*!
\fn void Core::IFindFilter::readSettings(QSettings *settings) \fn void Core::IFindFilter::readSettings(Utils::QtcSettings *settings)
Called at startup to read the state of the additional options Called at startup to read the state of the additional options
for this find filter from the \a settings. for this find filter from the \a settings.
*/ */

11
src/plugins/coreplugin/find/searchresultwindow.cpp
View File

@@ -288,10 +288,13 @@ using namespace Core::Internal;
This enum type specifies whether the search results should be sorted or This enum type specifies whether the search results should be sorted or
ordered: ordered:
\value AddSorted \value AddSortedByContent
The search results are sorted. The search results are sorted alphabetically.
\value AddSortedByPosition
The search results are sorted by the search results' reported line
numbers.
\value AddOrdered \value AddOrdered
The search results are ordered. The search results are ordered as they are reported.
*/ */
/*! /*!
@@ -331,7 +334,7 @@ using namespace Core::Internal;
\brief The SearchResultWindow class is the implementation of a commonly \brief The SearchResultWindow class is the implementation of a commonly
shared \uicontrol{Search Results} output pane. shared \uicontrol{Search Results} output pane.
\image qtcreator-search-results.webp {Search Results view} \image qtcreator-search-results-reg-exp.webp {Search Results view with search results}
Whenever you want to show the user a list of search results, or want Whenever you want to show the user a list of search results, or want
to present UI for a global search and replace, use the single instance to present UI for a global search and replace, use the single instance