aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2024-05-16 15:22:49 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2024-05-17 06:57:23 +0000
commit58abfc52e52ca7d3f833cc18ce38e209e86b1094 (patch)
treeba1c8bab458a854ad16570e52047f19cd6ffa645
parent450611ddccb4ad83eb9eb42c475a4476307b1e92 (diff)
Doc: Fix QDoc warnings for the API reference
Change-Id: I3507009756822f3ac795057a37c5f34a6e2bcd10 Reviewed-by: <github-actions-qt-creator@cristianadam.eu> Reviewed-by: Eike Ziller <eike.ziller@qt.io>
-rw-r--r--src/libs/extensionsystem/pluginview.cpp5
-rw-r--r--src/plugins/coreplugin/find/ifindfilter.cpp8
-rw-r--r--src/plugins/coreplugin/find/searchresultwindow.cpp11
3 files changed, 14 insertions, 10 deletions
diff --git a/src/libs/extensionsystem/pluginview.cpp b/src/libs/extensionsystem/pluginview.cpp
index 40738be487..b29e5c21f6 100644
--- a/src/libs/extensionsystem/pluginview.cpp
+++ b/src/libs/extensionsystem/pluginview.cpp
@@ -50,8 +50,9 @@
*/
/*!
- \fn void ExtensionSystem::PluginView::pluginSettingsChanged(ExtensionSystem::PluginSpec *spec)
- The settings for the plugin list entry corresponding to \a spec changed.
+ \fn void ExtensionSystem::PluginView::pluginsChanged(const QSet<ExtensionSystem::PluginSpec *> &spec, bool enabled)
+ The value of \a enabled for the plugin list entry corresponding to \a spec
+ changed.
*/
using namespace Utils;
diff --git a/src/plugins/coreplugin/find/ifindfilter.cpp b/src/plugins/coreplugin/find/ifindfilter.cpp
index 704f827bf8..49a891e659 100644
--- a/src/plugins/coreplugin/find/ifindfilter.cpp
+++ b/src/plugins/coreplugin/find/ifindfilter.cpp
@@ -30,7 +30,7 @@ using namespace Utils;
and \uicontrol {Files in File System} where the user provides a directory and file
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
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
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
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
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
for this find filter from the \a settings.
*/
diff --git a/src/plugins/coreplugin/find/searchresultwindow.cpp b/src/plugins/coreplugin/find/searchresultwindow.cpp
index 8412a57d70..eea0c43d4e 100644
--- a/src/plugins/coreplugin/find/searchresultwindow.cpp
+++ b/src/plugins/coreplugin/find/searchresultwindow.cpp
@@ -288,10 +288,13 @@ using namespace Core::Internal;
This enum type specifies whether the search results should be sorted or
ordered:
- \value AddSorted
- The search results are sorted.
+ \value AddSortedByContent
+ The search results are sorted alphabetically.
+ \value AddSortedByPosition
+ The search results are sorted by the search results' reported line
+ numbers.
\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
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
to present UI for a global search and replace, use the single instance