diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-05 14:29:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-20 11:22:47 +0200 |
| commit | 41411165bac561d3cd93a793c6ae76dcb2937e12 (patch) | |
| tree | cc9e5e516899407448ad8eadd207909ee3115493 /src/plugins/vcsbase/vcsbasesubmiteditor.cpp | |
| parent | 440725322abf0189c0cb28baddebe76bc26c5f05 (diff) | |
| download | qt-creator-41411165bac561d3cd93a793c6ae76dcb2937e12.tar.gz | |
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>
Diffstat (limited to 'src/plugins/vcsbase/vcsbasesubmiteditor.cpp')
| -rw-r--r-- | src/plugins/vcsbase/vcsbasesubmiteditor.cpp | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/plugins/vcsbase/vcsbasesubmiteditor.cpp b/src/plugins/vcsbase/vcsbasesubmiteditor.cpp index b4c7e3e2d5..e8c1cfd1d9 100644 --- a/src/plugins/vcsbase/vcsbasesubmiteditor.cpp +++ b/src/plugins/vcsbase/vcsbasesubmiteditor.cpp @@ -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 |