forked from qt-creator/qt-creator
Doc: use standard wording in \brief commands
QDoc does some magic with the \class and \namespaces and \brief commands, so the following wording must be used: "The xxx class yyy ..." Change-Id: Id231f30e8464898b776888d5423523de404aae34 Reviewed-by: Eike Ziller <eike.ziller@digia.com>
This commit is contained in:
@@ -89,7 +89,8 @@ namespace VcsBase {
|
||||
/*!
|
||||
\class VcsBase::DiffChunk
|
||||
|
||||
\brief A diff chunk consisting of file name and chunk data.
|
||||
\brief The DiffChunk class provides a diff chunk consisting of file name
|
||||
and chunk data.
|
||||
*/
|
||||
|
||||
bool DiffChunk::isValid() const
|
||||
@@ -132,7 +133,8 @@ namespace VcsBase {
|
||||
/*!
|
||||
\class VcsBase::VcsBaseEditor
|
||||
|
||||
\brief An editor with no support for duplicates.
|
||||
\brief The VcsBaseEditor class implements an editor with no support for
|
||||
duplicates.
|
||||
|
||||
Creates a browse combo in the toolbar for diff output.
|
||||
It also mirrors the signals of the VcsBaseEditor since the editor
|
||||
@@ -173,7 +175,8 @@ VcsBaseEditor::VcsBaseEditor(VcsBaseEditorWidget *widget,
|
||||
namespace Internal {
|
||||
|
||||
/*! \class AbstractTextCursorHandler
|
||||
* \brief Provides an interface to handle the contents under a text cursor inside an editor
|
||||
* \brief The AbstractTextCursorHandler class provides an interface to handle
|
||||
* the contents under a text cursor inside an editor.
|
||||
*/
|
||||
class AbstractTextCursorHandler : public QObject
|
||||
{
|
||||
@@ -238,7 +241,8 @@ QTextCursor AbstractTextCursorHandler::currentCursor() const
|
||||
}
|
||||
|
||||
/*! \class ChangeTextCursorHandler
|
||||
* \brief Provides a handler for VCS change identifiers
|
||||
* \brief The ChangeTextCursorHandler class provides a handler for VCS change
|
||||
* identifiers.
|
||||
*/
|
||||
class ChangeTextCursorHandler : public AbstractTextCursorHandler
|
||||
{
|
||||
@@ -368,7 +372,8 @@ QAction *ChangeTextCursorHandler::createCopyRevisionAction(const QString &change
|
||||
}
|
||||
|
||||
/*! \class UrlTextCursorHandler
|
||||
* \brief Provides a handler for URL like http://qt-project.org/
|
||||
* \brief The UrlTextCursorHandler class provides a handler for URLs, such as
|
||||
* http://qt-project.org/.
|
||||
*
|
||||
* The URL pattern can be redefined in sub-classes with setUrlPattern(), by default the pattern
|
||||
* works for hyper-text URL
|
||||
@@ -507,7 +512,8 @@ QAction *UrlTextCursorHandler::createCopyUrlAction(const QString &text) const
|
||||
}
|
||||
|
||||
/*! \class EmailTextCursorHandler
|
||||
* \brief Provides a handler for email addresses
|
||||
* \brief The EmailTextCursorHandler class provides a handler for email
|
||||
* addresses.
|
||||
*/
|
||||
class EmailTextCursorHandler : public UrlTextCursorHandler
|
||||
{
|
||||
@@ -618,10 +624,13 @@ QComboBox *VcsBaseEditorWidgetPrivate::entriesComboBox()
|
||||
} // namespace Internal
|
||||
|
||||
/*!
|
||||
\struct VcsBase::VcsBaseEditorParameters
|
||||
\class VcsBase::VcsBaseEditorParameters
|
||||
|
||||
\brief Helper struct used to parametrize an editor with mime type, context
|
||||
and id. The extension is currently only a suggestion when running
|
||||
\brief The VcsBaseEditorParameters class is a helper class used to
|
||||
parametrize an editor with MIME type, context
|
||||
and id.
|
||||
|
||||
The extension is currently only a suggestion when running
|
||||
VCS commands with redirection.
|
||||
|
||||
\sa VcsBase::VcsBaseEditorWidget, VcsBase::BaseVcsEditorFactory, VcsBase::EditorContentType
|
||||
@@ -630,7 +639,8 @@ QComboBox *VcsBaseEditorWidgetPrivate::entriesComboBox()
|
||||
/*!
|
||||
\class VcsBase::VcsBaseEditorWidget
|
||||
|
||||
\brief Base class for editors showing version control system output
|
||||
\brief The VcsBaseEditorWidget class is the base class for editors showing
|
||||
version control system output
|
||||
of the type enumerated by EditorContentType.
|
||||
|
||||
The source property should contain the file or directory the log
|
||||
|
||||
Reference in New Issue
Block a user