API Documentation: Add VCSBase.

1 files changed, 16 insertions, 0 deletions

diff --git a/src/plugins/vcsbase/checkoutjobs.cpp b/src/plugins/vcsbase/checkoutjobs.cpp
index 4f3c025fa84..dc110879223 100644
--- a/src/plugins/vcsbase/checkoutjobs.cpp
+++ b/src/plugins/vcsbase/checkoutjobs.cpp
@@ -43,6 +43,16 @@
 #include <utils/qtcassert.h>
 
 enum { debug = 0 };
+
+/*!
+    \class  VCSBase::AbstractCheckoutJob
+
+    \brief 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
+*/
+
 namespace VCSBase {
 
 AbstractCheckoutJob::AbstractCheckoutJob(QObject *parent) :
@@ -82,6 +92,12 @@ static inline QSharedPointer<QProcess> createProcess()
     return Utils::SynchronousProcess::createProcess(flags);
 }
 
+/*!
+    \class VCSBase::ProcessCheckoutJob
+
+    \brief Convenience implementation of a VCSBase::AbstractCheckoutJob using a QProcess.
+*/
+
 ProcessCheckoutJobPrivate::ProcessCheckoutJobPrivate() :
     process(createProcess())
 {