diff options
| author | Leena Miettinen <[email protected]> | 2013-06-05 14:29:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <[email protected]> | 2013-06-20 11:22:47 +0200 |
| commit | 41411165bac561d3cd93a793c6ae76dcb2937e12 (patch) | |
| tree | cc9e5e516899407448ad8eadd207909ee3115493 /src/plugins/vcsbase/checkoutjobs.cpp | |
| parent | 440725322abf0189c0cb28baddebe76bc26c5f05 (diff) | |
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 <[email protected]>
Diffstat (limited to 'src/plugins/vcsbase/checkoutjobs.cpp')
| -rw-r--r-- | src/plugins/vcsbase/checkoutjobs.cpp | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/src/plugins/vcsbase/checkoutjobs.cpp b/src/plugins/vcsbase/checkoutjobs.cpp index 7b618ec625f..6def0ade5f6 100644 --- a/src/plugins/vcsbase/checkoutjobs.cpp +++ b/src/plugins/vcsbase/checkoutjobs.cpp @@ -44,7 +44,9 @@ enum { debug = 0 }; /*! \class VcsBase::AbstractCheckoutJob - \brief Abstract base class for a job creating an initial project checkout. + \brief The AbstractCheckoutJob class is an abstract base class for a job + creating an initial project checkout. + It should be something that runs in the background producing log messages. \sa VcsBase::BaseCheckoutWizard @@ -104,7 +106,8 @@ AbstractCheckoutJob::AbstractCheckoutJob(QObject *parent) : /*! \class VcsBase::ProcessCheckoutJob - \brief Convenience implementation of a VcsBase::AbstractCheckoutJob using a QProcess. + \brief The ProcessCheckoutJob class is a convenience implementation of a + VcsBase::AbstractCheckoutJob using a QProcess. */ ProcessCheckoutJob::ProcessCheckoutJob(QObject *parent) : |