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

Doc: use standard wording in \brief commands

Browse Source 
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:
Leena Miettinen
2013-06-05 14:29:24 +02:00
parent 440725322a
commit 41411165ba
162 changed files with 486 additions and 291 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/plugins/vcsbase/vcsbasesubmiteditor.cpp
View File

@@ -97,15 +97,17 @@ static const char *belongingClassName(const CPlusPlus::Function *function)
}
/*!
\struct VcsBase::VcsBaseSubmitEditorParameters
\class VcsBase::VcsBaseSubmitEditorParameters
\brief Utility struct to parametrize a VcsBaseSubmitEditor.
\brief The VcsBaseSubmitEditorParameters class is a utility class
to parametrize a VcsBaseSubmitEditor.
*/
/*!
\class VcsBase::VcsBaseSubmitEditor
\brief Base class for a submit editor based on the SubmitEditorWidget.
\brief The VcsBaseSubmitEditor class is the base class for a submit editor
based on the SubmitEditorWidget.
Presents the commit message in a text editor and an
checkable list of modified files in a list window. The user can delete