Doc: Fix QDoc warnings in ExtensionSystem class docs

Task-number: QTCREATORBUG-23544
Change-Id: I6500fefdaa919f807fa4bf4372426b19a6e57aa2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2020-02-07 16:02:22 +01:00
parent 13cd5add85
commit 62a2b1718d
5 changed files with 26 additions and 2 deletions

View File

@@ -38,6 +38,7 @@
/*!
\class ExtensionSystem::PluginDetailsView
\inmodule QtCreator
\brief The PluginDetailsView class implements a widget that displays the
contents of a PluginSpec.

View File

@@ -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)

View File

@@ -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.

View File

@@ -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

View File

@@ -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();