summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2020-02-07 16:02:22 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2020-02-07 15:12:41 +0000
commit62a2b1718df53e2df9f72de48140053e858783c8 (patch)
tree353ed9208c5e2a24b8aaf3b0c22734aab744b194
parent13cd5add85aa336021d942904305addc1443d886 (diff)
downloadqt-creator-62a2b1718df53e2df9f72de48140053e858783c8.tar.gz
Doc: Fix QDoc warnings in ExtensionSystem class docs
Task-number: QTCREATORBUG-23544 Change-Id: I6500fefdaa919f807fa4bf4372426b19a6e57aa2 Reviewed-by: Eike Ziller <eike.ziller@qt.io>
-rw-r--r--src/libs/extensionsystem/plugindetailsview.cpp1
-rw-r--r--src/libs/extensionsystem/pluginerroroverview.cpp5
-rw-r--r--src/libs/extensionsystem/pluginerrorview.cpp1
-rw-r--r--src/libs/extensionsystem/pluginmanager.cpp2
-rw-r--r--src/libs/extensionsystem/pluginview.cpp19
5 files changed, 26 insertions, 2 deletions
diff --git a/src/libs/extensionsystem/plugindetailsview.cpp b/src/libs/extensionsystem/plugindetailsview.cpp
index 13f24d3889..e89e054b88 100644
--- a/src/libs/extensionsystem/plugindetailsview.cpp
+++ b/src/libs/extensionsystem/plugindetailsview.cpp
@@ -38,6 +38,7 @@
/*!
\class ExtensionSystem::PluginDetailsView
+ \inmodule QtCreator
\brief The PluginDetailsView class implements a widget that displays the
contents of a PluginSpec.
diff --git a/src/libs/extensionsystem/pluginerroroverview.cpp b/src/libs/extensionsystem/pluginerroroverview.cpp
index 74e7ac73b0..ff4f3bcd5c 100644
--- a/src/libs/extensionsystem/pluginerroroverview.cpp
+++ b/src/libs/extensionsystem/pluginerroroverview.cpp
@@ -32,6 +32,11 @@ Q_DECLARE_METATYPE(ExtensionSystem::PluginSpec*)
namespace ExtensionSystem {
+/*!
+ \class ExtensionSystem::PluginErrorOverview
+ \internal
+*/
+
PluginErrorOverview::PluginErrorOverview(QWidget *parent) :
QDialog(parent),
m_ui(new Internal::Ui::PluginErrorOverview)
diff --git a/src/libs/extensionsystem/pluginerrorview.cpp b/src/libs/extensionsystem/pluginerrorview.cpp
index 19d53b3a94..5e80a6b24b 100644
--- a/src/libs/extensionsystem/pluginerrorview.cpp
+++ b/src/libs/extensionsystem/pluginerrorview.cpp
@@ -31,6 +31,7 @@
/*!
\class ExtensionSystem::PluginErrorView
+ \inmodule QtCreator
\brief The PluginErrorView class implements a widget that displays the
state and error message of a PluginSpec.
diff --git a/src/libs/extensionsystem/pluginmanager.cpp b/src/libs/extensionsystem/pluginmanager.cpp
index b07a03614e..78b636323a 100644
--- a/src/libs/extensionsystem/pluginmanager.cpp
+++ b/src/libs/extensionsystem/pluginmanager.cpp
@@ -71,6 +71,7 @@ enum { debugLeaks = 0 };
/*!
\namespace ExtensionSystem
+ \inmodule QtCreator
\brief The ExtensionSystem namespace provides classes that belong to the
core plugin system.
@@ -85,6 +86,7 @@ enum { debugLeaks = 0 };
/*!
\class ExtensionSystem::PluginManager
+ \inmodule QtCreator
\ingroup mainclasses
\brief The PluginManager class implements the core plugin system that
diff --git a/src/libs/extensionsystem/pluginview.cpp b/src/libs/extensionsystem/pluginview.cpp
index bb5d6b98ed..a5763e2067 100644
--- a/src/libs/extensionsystem/pluginview.cpp
+++ b/src/libs/extensionsystem/pluginview.cpp
@@ -44,6 +44,7 @@
/*!
\class ExtensionSystem::PluginView
+ \inmodule QtCreator
\brief The PluginView class implements a widget that shows a list of all
plugins and their state.
@@ -67,6 +68,11 @@
for example by a double-click.
*/
+/*!
+ \fn void PluginView::pluginSettingsChanged(ExtensionSystem::PluginSpec *spec)
+ The settings for the plugin list entry corresponding to \a spec changed.
+*/
+
Q_DECLARE_METATYPE(ExtensionSystem::PluginSpec*)
using namespace Utils;
@@ -321,8 +327,8 @@ private:
using namespace ExtensionSystem::Internal;
/*!
- Constructs a PluginView that gets the list of plugins from the
- given plugin \a manager with a given \a parent widget.
+ Constructs a plugin view with \a parent that displays a list of plugins
+ from a plugin manager.
*/
PluginView::PluginView(QWidget *parent)
: QWidget(parent)
@@ -383,18 +389,27 @@ PluginSpec *PluginView::currentPlugin() const
return pluginForIndex(m_categoryView->currentIndex());
}
+/*!
+ Sets the \a filter for listing plugins.
+*/
void PluginView::setFilter(const QString &filter)
{
m_sortModel->setFilterFixedString(filter);
m_categoryView->expandAll();
}
+/*!
+ Sets the list filtering to \a showHidden.
+*/
void PluginView::setShowHidden(bool showHidden)
{
m_sortModel->setShowHidden(showHidden);
m_categoryView->expandAll();
}
+/*!
+ Returns whether hidden plugins are listed.
+*/
bool PluginView::isShowingHidden() const
{
return m_sortModel->isShowingHidden();