forked from qt-creator/qt-creator
Doc: Fix more documentation warnings for Extending Qt Creator Manual
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:
@@ -50,20 +50,14 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn INavigationWidgetFactory::INavigationWidgetFactory()
|
\fn QString Core::INavigationWidgetFactory::displayName() const
|
||||||
|
|
||||||
Constructs a navigation widget factory.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*!
|
|
||||||
\fn QString INavigationWidgetFactory::displayName() const
|
|
||||||
|
|
||||||
Returns the display name of the navigation widget, which is shown in the dropdown menu above the
|
Returns the display name of the navigation widget, which is shown in the dropdown menu above the
|
||||||
navigation widget.
|
navigation widget.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\fn int INavigationWidgetFactory::priority() const
|
\fn int Core::INavigationWidgetFactory::priority() const
|
||||||
|
|
||||||
Determines the position of the navigation widget in the dropdown menu.
|
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.
|
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
|
Returns a \l{Core::NavigationView} containing the widget and the buttons. The ownership is given
|
||||||
to the caller.
|
to the caller.
|
||||||
@@ -88,7 +82,7 @@ using namespace Core;
|
|||||||
static QList<INavigationWidgetFactory *> g_navigationWidgetFactories;
|
static QList<INavigationWidgetFactory *> g_navigationWidgetFactories;
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
Creates a \l{Core::NavigationViewFactory}.
|
Constructs a navigation widget factory.
|
||||||
*/
|
*/
|
||||||
INavigationWidgetFactory::INavigationWidgetFactory()
|
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()
|
\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()
|
\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()
|
\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()
|
\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).
|
(the \a position identifies a specific navigation widget).
|
||||||
|
|
||||||
\sa INavigationWidgetFactory::restoreSettings()
|
\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).
|
factory (the \a position identifies a specific navigation widget).
|
||||||
|
|
||||||
\sa INavigationWidgetFactory::saveSettings()
|
\sa INavigationWidgetFactory::saveSettings()
|
||||||
|
@@ -27,6 +27,8 @@
|
|||||||
|
|
||||||
#include "ioutputpane.h"
|
#include "ioutputpane.h"
|
||||||
|
|
||||||
|
namespace Core {
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
\class Core::IOutputPane
|
\class Core::IOutputPane
|
||||||
\brief The IOutputPane class is an interface for providing \uicontrol Output panes.
|
\brief The IOutputPane class is an interface for providing \uicontrol Output panes.
|
||||||
@@ -258,3 +260,5 @@
|
|||||||
Displays \a number in the status bar button belonging to the output pane
|
Displays \a number in the status bar button belonging to the output pane
|
||||||
(for example, number of issues on building).
|
(for example, number of issues on building).
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
} // namespace Core
|
||||||
|
@@ -37,6 +37,7 @@
|
|||||||
|
|
||||||
/*!
|
/*!
|
||||||
\class Core::IVersionControl::TopicCache
|
\class Core::IVersionControl::TopicCache
|
||||||
|
\inmodule QtCreator
|
||||||
\brief The TopicCache class stores a cache which maps a directory to a topic.
|
\brief The TopicCache class stores a cache which maps a directory to a topic.
|
||||||
|
|
||||||
A VCS topic is typically the current active branch name, but it can also have other
|
A VCS topic is typically the current active branch name, but it can also have other
|
||||||
|
@@ -125,7 +125,7 @@ void BaseTextDocument::setLineTerminationMode(Utils::TextFileFormat::LineTermina
|
|||||||
Autodetects file format and reads the text file specified by \a fileName
|
Autodetects file format and reads the text file specified by \a fileName
|
||||||
into a list of strings specified by \a plainTextList.
|
into a list of strings specified by \a plainTextList.
|
||||||
|
|
||||||
If an error occurs while writing the file, \a errorMessage is set to the
|
If an error occurs while writing the file, \a errorString is set to the
|
||||||
error details.
|
error details.
|
||||||
|
|
||||||
Returns whether the operation was successful.
|
Returns whether the operation was successful.
|
||||||
@@ -143,7 +143,7 @@ BaseTextDocument::ReadResult BaseTextDocument::read(const QString &fileName, QSt
|
|||||||
Autodetects file format and reads the text file specified by \a fileName
|
Autodetects file format and reads the text file specified by \a fileName
|
||||||
into \a plainText.
|
into \a plainText.
|
||||||
|
|
||||||
If an error occurs while writing the file, \a errorMessage is set to the
|
If an error occurs while writing the file, \a errorString is set to the
|
||||||
error details.
|
error details.
|
||||||
|
|
||||||
Returns whether the operation was successful.
|
Returns whether the operation was successful.
|
||||||
|
Reference in New Issue
Block a user