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

Doc: Fix more documentation warnings for Extending Qt Creator Manual

Browse Source 
Change-Id: I3ba4e6d2f6cfa2c05c0ee7af6db70dcbb80ae725
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Topi Reinio
2020-03-25 11:29:32 +01:00
committed by Topi Reiniö
parent b06ad16160
commit 595085cb71
4 changed files with 18 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
src/plugins/coreplugin/inavigationwidgetfactory.cpp
View File

@@ -50,20 +50,14 @@
*/
/*!
\fn INavigationWidgetFactory::INavigationWidgetFactory()
Constructs a navigation widget factory.
*/
/*!
\fn QString INavigationWidgetFactory::displayName() const
\fn QString Core::INavigationWidgetFactory::displayName() const
Returns the display name of the navigation widget, which is shown in the dropdown menu above the
navigation widget.
*/
/*!
\fn int INavigationWidgetFactory::priority() const
\fn int Core::INavigationWidgetFactory::priority() const
Determines the position of the navigation widget in the dropdown menu.
@@ -71,13 +65,13 @@
*/
/*!
\fn Id INavigationWidgetFactory::id() const
\fn Id Core::INavigationWidgetFactory::id() const
Returns a unique identifier for referencing the navigation widget factory.
*/
/*!
\fn NavigationView INavigationWidgetFactory::createWidget()
\fn Core::NavigationView Core::INavigationWidgetFactory::createWidget()
Returns a \l{Core::NavigationView} containing the widget and the buttons. The ownership is given
to the caller.
@@ -88,7 +82,7 @@ using namespace Core;
static QList<INavigationWidgetFactory *> g_navigationWidgetFactories;
/*!
Creates a \l{Core::NavigationViewFactory}.
Constructs a navigation widget factory.
*/
INavigationWidgetFactory::INavigationWidgetFactory()
{
@@ -106,7 +100,7 @@ const QList<INavigationWidgetFactory *> INavigationWidgetFactory::allNavigationF
}
/*!
Sets the display name for the factory.
Sets the display name for the factory to \a displayName.
\sa displayName()
*/
@@ -116,7 +110,7 @@ void INavigationWidgetFactory::setDisplayName(const QString &displayName)
}
/*!
Sets the priority for the factory.
Sets the \a priority for the factory.
\sa priority()
*/
@@ -126,7 +120,7 @@ void INavigationWidgetFactory::setPriority(int priority)
}
/*!
Sets the id for the factory.
Sets the \a id for the factory.
\sa id()
*/
@@ -136,7 +130,7 @@ void INavigationWidgetFactory::setId(Id id)
}
/*!
Sets the keyboard activation sequence for the factory.
Sets the keyboard activation sequence for the factory to \a keys.
\sa activationSequence()
*/
@@ -154,7 +148,7 @@ QKeySequence INavigationWidgetFactory::activationSequence() const
}
/*!
Stores the settings for the \a widget at \a position that was created by this factory
Stores the \a settings for the \a widget at \a position that was created by this factory
(the \a position identifies a specific navigation widget).
\sa INavigationWidgetFactory::restoreSettings()
@@ -164,7 +158,7 @@ void INavigationWidgetFactory::saveSettings(QSettings * /* settings */, int /* p
}
/*!
Reads and restores the settings for the \a widget at \a position that was created by this
Reads and restores the \a settings for the \a widget at \a position that was created by this
factory (the \a position identifies a specific navigation widget).
\sa INavigationWidgetFactory::saveSettings()