Merge lp:~mandel/ubuntu-download-manager/documentation into lp:ubuntu-download-manager

[Manuel de la Peña]

Improved the documentation of the project. The registerMetaType function was removed because it is not needed and not used in any part of the code. const have been added in those methods that simply are used as getters. The descturtors that can be trusted to the compiler have been removed to reduce clutter in the code.

Improve the documentation of the project. This is a first step, more to will be added.

[lp:~mandel/ubuntu-download-manager/documentation]

251. By Manuel de la Peña on 2014-03-06

Merged with trunk.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:251
http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-ci/368/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-trusty-amd64-ci/257/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-trusty-armhf-ci/257

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-download-manager-ci/368/rebuild

review: Needs Fixing (continuous-integration)

[lp:~mandel/ubuntu-download-manager/documentation]

252. By Manuel de la Peña on 2014-03-19

Merged with trunk.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:252
http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-ci/378/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-trusty-amd64-ci/267/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-trusty-armhf-ci/267

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-download-manager-ci/378/rebuild

review: Needs Fixing (continuous-integration)

[lp:~mandel/ubuntu-download-manager/documentation]

253. By Manuel de la Peña on 2014-03-19

Increase timeout.

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:253
http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-ci/379/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-trusty-amd64-ci/268
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-download-manager-trusty-armhf-ci/268

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-download-manager-ci/379/rebuild

review: Approve (continuous-integration)

=== modified file 'ubuntu-download-manager-client-tests/ubuntu-download-manager-client-tests.pro'
--- ubuntu-download-manager-client-tests/ubuntu-download-manager-client-tests.pro	2014-02-05 13:04:13 +0000
+++ ubuntu-download-manager-client-tests/ubuntu-download-manager-client-tests.pro	2014-03-19 19:29:24 +0000
@@ -57,5 +57,5 @@
 
 
 check.depends = $${TARGET}
-check.commands = LD_LIBRARY_PATH=$$OUT_PWD/../ubuntu-download-manager-common:$$OUT_PWD/../ubuntu-download-manager-client:$$OUT_PWD/../ubuntu-download-manager-test-lib:$$OUT_PWD/../ubuntu-download-manager-priv  dbus-test-runner -m 120 --task=./$${TARGET} -c
+check.commands = LD_LIBRARY_PATH=$$OUT_PWD/../ubuntu-download-manager-common:$$OUT_PWD/../ubuntu-download-manager-client:$$OUT_PWD/../ubuntu-download-manager-test-lib:$$OUT_PWD/../ubuntu-download-manager-priv  dbus-test-runner -m 240 --task=./$${TARGET} -c
 QMAKE_EXTRA_TARGETS += check

=== modified file 'ubuntu-download-manager-client/ubuntu/download_manager/download.h'
--- ubuntu-download-manager-client/ubuntu/download_manager/download.h	2014-02-12 12:01:11 +0000
+++ ubuntu-download-manager-client/ubuntu/download_manager/download.h	2014-03-19 19:29:24 +0000
@@ -29,6 +29,24 @@
 namespace DownloadManager {
 
 class Error;
+
+/*!
+    \class Download
+    \brief The Download class allows to control a download that
+           was created in the download manager.
+    \since 0.3
+
+    The Download class represents a download request that was
+    created to  be performed by the download manager.
+
+    Due to the asynchronous nature of the API a download request
+    is not performed on the Download object creation but after
+    the client has requested it via the \l Download::start method.
+
+    \note The ownership of the Download is relayed to the caller and
+    therefore the client must call delete or deleteLater whenever it
+    considers to be appropriate.
+*/
 class DOWNLOAD_MANAGER_EXPORT Download : public QObject {
     Q_OBJECT
 
@@ -36,33 +54,203 @@
     explicit Download(QObject* parent = 0)
         : QObject(parent) {}
 
+    /*!
+        \fn void Download::start()
+
+        Notifies the download manager that the download that is
+        represented by this download object is ready to be downloaded.
+
+        The normal use case is that the client of the API connects to
+        all the download signals that he is interested in and the calls the
+        start methods. This pattern ensures that if a download is performed
+        that all signals are connected else the client could see cases in
+        where no signals are received because the download finished before
+        he connected to the signals.
+    */
     virtual void start() = 0;
+
+    /*!
+        \fn void Download::pause()
+
+        Notifies the download manager that the download represented by this
+        download object must be paused.
+    */
     virtual void pause() = 0;
+
+    /*!
+        \fn void Download::resume()
+
+        Notifies the download manager that the download represented by this
+        download object must be resumed. There is no guarantee that nor errors
+        will be raised if a not paused download is resumed.
+    */
     virtual void resume() = 0;
+
+    /*!
+        \fn void Download::cancel()
+
+        Notifies the download manager that the download represented by this
+        download object must be canceled and all it resources must be cleaned.
+    */
     virtual void cancel() = 0;
 
+    /*!
+        \fn void Download::allowMobileDownload(bool allowed)
+
+        Notifies the download manager that the download represented by this
+        download object is allowed or not to use the phones mobile data whenever
+        the devices is connected to it. If the download is not allows to use
+        mobile data it will be automatically paused until a valid network
+        connection is present.
+    */
     virtual void allowMobileDownload(bool allowed) = 0;
+
+    /*!
+        \fn bool isMobileDownloadAllowed()
+
+        Returns if the download represented by this download object is allowed to
+        use the phones mobile data connection.
+    */
     virtual bool isMobileDownloadAllowed() = 0;
 
+    /*!
+        \fn void setThrottle(qulonglong speed)
+
+        Notifies the download manager that the download represented by this
+        download object has its download bandwidth limited to the value
+        provided by \a speed represented in bytes.
+    */
     virtual void setThrottle(qulonglong speed) = 0;
+
+    /*!
+        \fn qulonglong throttle()
+
+        Returns the bandwidth limit that was set for the download represented
+        by this object. If the result is 0 is that no limit was set.
+    */
     virtual qulonglong throttle() = 0;
 
+    /*!
+        \fn QString id() const
+
+        Returns the unique identifier that represents the download within
+        the download manager.
+    */
     virtual QString id() const = 0;
+
+    /*!
+        \fn QVariantMap metadata()
+
+        Returns the metadata used upon creation of the download represented
+        by the object.
+    */
     virtual QVariantMap metadata() = 0;
+
+    /*!
+        \fn qulonglong progress()
+
+        Returns the size of all the data downloaded so far in bytes.
+    */
     virtual qulonglong progress() = 0;
+
+    /*!
+        \fn qulonglong totalSize()
+
+        Returns the totals size estimated for the download. The result can
+        be 0 when the download manager was not able to deduce the download
+        size due to a wrong configuration of the server.
+    */
     virtual qulonglong totalSize() = 0;
 
+    /*!
+        \fn bool isError() const
+
+        Returns if the download represented by the object has had an error.
+    */
     virtual bool isError() const = 0;
+
+    /*!
+        \fn Error* error() const
+
+        Returns the last error encountered by the download object.
+    */
     virtual Error* error() const = 0;
 
  signals:
+
+    /*!
+        \fn void Download::canceled(bool success)
+
+        This signal is emitted whenever a download cancellation was requested
+        and notifies if the cancellation was successful or not via \a success.
+    */
     void canceled(bool success);
+
+    /*!
+        \fn void Download::error(Error* error)
+
+        This signal is emitted whenever and error occurred during a download.
+        To get more information about the cause of the error the client can check
+        the type of the error via \l Error::type() and cast \a error to the
+        appropriate subclass.
+    */
     void error(Error* error);
+
+    /*!
+        \fn void Download::finished(const QString& path)
+
+        This signal is emitted whenever a download has successfully completed.
+        \a path is the absolute local file path where the downloaded file can
+        be found.
+    */
     void finished(const QString& path);
+
+    /*!
+        \fn void Download::paused(bool success)
+
+        This signal is emitted whenever a download paused was requested and
+        notifies if the pause was successful or not via \a success.
+    */
     void paused(bool success);
+
+    /*!
+        \fn void Download::processing(const QString& path)
+
+        This signal is emitted whenever a post processing action is being
+        performed on the download file indicated by \a path.
+    */
     void processing(const QString &path);
+
+    /*!
+        \fn void Download::progress(qulonglong received, qulonglong total)
+
+        This signal is emitted to indicate the progress of the download  where
+        \a received is the number of bytes received and \a total is the total
+        size of the download.
+
+        \note If the download manager is not able to estimate the size of
+        a download, which is something that can happen when the server does
+        not correctly send the size back, \a received and \a total will have
+        the same value. The fact that the values are the same \tt DOES NOT
+        mean that a download was completed for that the signals
+        \l Download::finished(const QString& path) should be used.
+    */
     void progress(qulonglong received, qulonglong total);
+
+    /*!
+        \fn void Download::resumed(bool success)
+
+        This signal is emitted whenever a download resume was requested and
+        notifies if the resume was successful via \a success.
+    */
     void resumed(bool success);
+
+    /*!
+        \fn void Download::started(bool success)
+
+        This signal is emitted whenever a download start was requested and
+        notifies if the start action was successful via \a success.
+    */
     void started(bool success);
 
 };

=== modified file 'ubuntu-download-manager-client/ubuntu/download_manager/error.h'
--- ubuntu-download-manager-client/ubuntu/download_manager/error.h	2014-02-19 18:25:53 +0000
+++ ubuntu-download-manager-client/ubuntu/download_manager/error.h	2014-03-19 19:29:24 +0000
@@ -34,34 +34,79 @@
 class NetworkErrorStruct;
 class ProcessErrorStruct;
 class ErrorPrivate;
+
+/*!
+    \class Error
+    \brief The Error class is the base class that represents an
+           error in the download manager API.
+    \since 0.3
+
+    The Error class represents an error in the download manager and
+    can be of a number of types. The API is designed so that the client
+    only needs to listen to a single error signal and that can later
+    downcast the error class to get more detailed information.
+*/
 class DOWNLOAD_MANAGER_EXPORT Error : public QObject {
     Q_OBJECT
     Q_DECLARE_PRIVATE(Error)
 
  public:
+
+    /*!
+        Enumerator that represents the error type.
+    */
     enum Type {
-        Auth,
-        DBus,
-        Http,
-        Network,
-        Process
+        Auth,    /*! The error was due to a proxy or server authentication issue.*/
+        DBus,    /*! The error was due to some problem when communicating with the dbus API.*/
+        Http,    /*! The error was due to a http error, for example a 404.*/
+        Network, /*! The error was due to network problems such as a missing network interface.*/
+        Process  /*! The error was due to a problem when executing the post download command.*/
     };
 
+    /*!
+        Disposes of this error and frees any resources associated with it.
+    */
     virtual ~Error();
+
+    /*!
+        \fn void Error::Type()
+
+        Returns the type of the error that was encountered.
+     */
     Type type();
+
+    /*!
+        \fn QString errorString()
+
+        Returns a string representation of the error.
+    */
     virtual QString errorString();
 
  protected:
+    /*!
+        Creates a new error of the given type and with the given parent.
+        \internal
+    */
     Error(Type type, QObject* parent = 0);
 
  private:
-    // use pimpl pattern so that users do not have to be recompiled
+    /*!
+        Use pimpl pattern so that users do not have to be recompiled
+        \internal
+    */
     ErrorPrivate* d_ptr;
 
 };
 
 
 class DBusErrorPrivate;
+
+/*!
+    \class DbusError
+    \brief The DbusError represents an error that occurred during the
+           interaction with the DBus API.
+    \since 0.3
+*/
 class DOWNLOAD_MANAGER_EXPORT DBusError : public Error {
     Q_OBJECT
     Q_DECLARE_PRIVATE(DBusError)
@@ -72,20 +117,62 @@
     friend class DownloadPendingCallWatcher;
     friend class GroupManagerPendingCallWatcher;
 
+    /*!
+        Disposes of this error and frees any resources associated with it.
+    */
     virtual ~DBusError();
+
+    /*!
+        \fn QString message()
+
+        Returns a DBus error message that is readable by a human.
+    */
     QString message();
+
+    /*!
+        \fn QString name();
+
+        Returns the name of the DBus error.
+    */
     QString name();
+
+    /*!
+        \fn QString errorString() override
+
+        Returns a string representation of the error.
+    */
     QString errorString() override;
 
  protected:
+
+    /*!
+        Creates a new error from the provided QDbusError with a
+        given parent.
+        \internal
+    */
     DBusError(QDBusError err, QObject* parent = 0);
 
  private:
-    // use pimpl pattern so that users do not have to be recompiled
+    /*!
+        Use pimpl pattern so that users do not have to be recompiled
+        \internal
+    */
     DBusErrorPrivate* d_ptr;
 };
 
 class AuthErrorPrivate;
+
+/*!
+    \class AuthError
+    \brief The AuthError represents an authentication error that occurred
+           during the request of the download.
+    \since 0.3
+
+    The AuthError can occur due to two different reasons, either the
+    download required a server side authentication or the download was
+    performed via a proxy that requires authentication and was not
+    provided.
+*/
 class DOWNLOAD_MANAGER_EXPORT AuthError : public Error {
     Q_OBJECT
     Q_DECLARE_PRIVATE(AuthError)
@@ -93,25 +180,68 @@
     friend class DownloadImpl;
 
  public:
+
+    /*!
+        Enumerator that represents the type of authentication error.
+    */
     enum Type {
-        Server,
-        Proxy
+        Server, /*! The server needed authentication and it was not provided.*/
+        Proxy   /*! The proxy needed authentication and it was not provided. */
     };
 
+    /*!
+        Disposes of this error and frees any resources associated with it.
+    */
     virtual ~AuthError();
+
+    /*!
+        /fn Type type()
+
+        Returns the type of authentication error.
+    */
     Type type();
+
+    /*!
+        /fn QString phrase()
+
+        Returns a human readable explanation for the authentication
+        error.
+    */
     QString phrase();
+
+    /*!
+        /fn QString errorString() override
+
+        Returns a string representation of the error.
+    */
     QString errorString() override;
 
  protected:
+    /*!
+        Creates a new error from the provided authentication error struct.
+        \internal
+    */
     AuthError(AuthErrorStruct err, QObject* parent);
 
  private:
-    // use pimpl pattern so that users do not have to be recompiled
+    /*!
+        Use pimpl pattern so that users do not have to be recompiled
+        \internal
+    */
     AuthErrorPrivate* d_ptr;
 };
 
 class HttpErrorPrivate;
+
+/*!
+    \class HttpError 
+    \brief The HttpError represents an error that occurred during the
+           download request.
+    \since 0.3
+
+    The HttpError represents an error that occurred during the download
+    request and that is related to one of the known http 1.1 error codes.
+*/
 class DOWNLOAD_MANAGER_EXPORT HttpError : public Error {
     Q_OBJECT
     Q_DECLARE_PRIVATE(HttpError)
@@ -119,20 +249,57 @@
     friend class DownloadImpl;
 
  public:
+
+    /*!
+        Disposes of this error and frees any resources associated with it.
+    */
     virtual ~HttpError();
+
+    /*!
+        /fn int code()
+
+        Returns the http error code, for example 404.
+    */
     int code();
+
+    /*!
+        /fn QString phrase()
+
+        Returns a human readable reason for the http error.
+    */
     QString phrase();
+
+    /*!
+        /fn QString errorString() override
+
+        Returns a string representation of the error.
+    */
     QString errorString() override;
 
  protected:
+
+    /*!
+        Creates a new error from the provided http error struct.
+        \internal
+    */
     HttpError(HttpErrorStruct err, QObject* parent);
 
  private:
-    // use pimpl pattern so that users do not have to be recompiled
+    /*!
+        Use pimpl pattern so that users do not have to be recompiled
+        \internal
+    */
     HttpErrorPrivate* d_ptr;
 };
 
 class NetworkErrorPrivate;
+
+/*!
+    \class NetworkError
+    \brief The NetworkError represents an error that occurred during the
+           download request.
+    \since 0.3
+*/
 class DOWNLOAD_MANAGER_EXPORT NetworkError : public Error {
     Q_OBJECT
     Q_DECLARE_PRIVATE(NetworkError)
@@ -140,48 +307,89 @@
     friend class DownloadImpl;
 
  public:
+
+    /*!
+      Enumerator that indicates all possible error conditions found during
+      the processing of the request.
+    */
     enum ErrorCode {
-        ConnectionRefusedError,
-        RemoteHostClosedError,
-        HostNotFoundError,
-        TimeoutError,
-        OperationCanceledError,
-        SslHandshakeFailedError,
-        TemporaryNetworkFailureError,
-        NetworkSessionFailedError,
-        BackgroundRequestNotAllowedError,
-        ProxyConnectionRefusedError,
-        ProxyConnectionClosedError,
-        ProxyNotFoundError,
-        ProxyTimeoutError,
-        ProxyAuthenticationRequiredError,
-        ContentAccessDenied,
-        ContentOperationNotPermittedError,
-        ContentNotFoundError,
-        AuthenticationRequiredError,
-        ContentReSendError,
-        ProtocolUnknownError,
-        ProtocolInvalidOperationError,
-        UnknownNetworkError,
-        UnknownProxyError,
-        UnknownContentError,
-        ProtocolFailure
+        ConnectionRefusedError,            /*! The remote server refused the connection (the server is not accepting requests). */
+        RemoteHostClosedError,             /*! The remote server closed the connection prematurely, before the entire reply was received and processed. */
+        HostNotFoundError,                 /*! The remote host name was not found (invalid hostname). */
+        TimeoutError,                      /*! The connection to the remote server timed out. */
+        OperationCanceledError,            /*! The operation was canceled. */
+        SslHandshakeFailedError,           /*! The  SSL/TLS handshake failed and the encrypted channel could not be established. */
+        TemporaryNetworkFailureError,      /*! The connection was broken due to disconnection from the networkd. */
+        NetworkSessionFailedError,         /*! The connection was broken due to disconnection from the network or failure to start the network. */
+        BackgroundRequestNotAllowedError,  /*! The background request is not currently allowed due to platform policy. */
+        ProxyConnectionRefusedError,       /*! The connection to the proxy server was refused (the proxy server is not accepting requests. )*/
+        ProxyConnectionClosedError,        /*! The proxy server closed the connection prematurely, before the entire reply was received and processed. */
+        ProxyNotFoundError,                /*! The proxy host name was not found (invalid proxy hostname). */
+        ProxyTimeoutError,                 /*! The connection to the proxy timed out or the proxy did not reply in time to the request sent. */
+        ProxyAuthenticationRequiredError,  /*! The proxy requires authentication in order to honour the request but did not accept any credentials offered.*/
+        ContentAccessDenied,               /*! The access to the remote content was denied. */
+        ContentOperationNotPermittedError, /*! The operation requested on the remote content is not permitted. */
+        ContentNotFoundError,              /*! The remote content was not found at the server. */
+        AuthenticationRequiredError,       /*! The remote server requires authentication to serve the content but the credentials provided were not accepted. */
+        ContentReSendError,                /*! The request needed to be sent again, but this failed. */
+        ProtocolUnknownError,              /*! The Network Access API cannot honor the request because the protocol is not known. */
+        ProtocolInvalidOperationError,     /*! The requested operation is invalid for this protocol. */
+        UnknownNetworkError,               /*! An unknown network-related error was detected. */
+        UnknownProxyError,                 /*! An unknown proxy-related error was detected. */
+        UnknownContentError,               /*! An breakdown in protocol was detected. */
+        ProtocolFailure                    /*! A breakdown in protocol was detected. */
     };
 
+    /*!
+        Disposes of this error and frees any resources associated with it.
+    */
     virtual ~NetworkError();
+
+    /*!
+        /fn ErrorCode code()
+
+        Returns the code that represents the occurred error.
+    */
     ErrorCode code();
+
+    /*!
+        /fn QString phrase()
+
+        Returns a human readable explanation of the occurred error.
+    */
     QString phrase();
+
+    /*!
+        /fn QString errorString() override
+
+        Returns a string representation of the error.
+    */
     QString errorString() override;
 
  protected:
+
+    /*!
+        Creates a new error from the provided http error struct.
+        \internal
+    */
     NetworkError(NetworkErrorStruct err, QObject* parent);
 
  private:
-    // use pimpl pattern so that users do not have to be recompiled
+    /*!
+        Use pimpl pattern so that users do not have to be recompiled
+        \internal
+    */
     NetworkErrorPrivate* d_ptr;
 };
 
 class ProcessErrorPrivate;
+
+/*!
+    \class ProcessError 
+    \brief The ProcessError represents an error that occurred during the
+           post processing of a downloaded file.
+    \since 0.3
+*/
 class DOWNLOAD_MANAGER_EXPORT ProcessError : public Error {
     Q_OBJECT
     Q_DECLARE_PRIVATE(ProcessError)
@@ -189,19 +397,67 @@
     friend class DownloadImpl;
 
  public:
+
+    /*!
+        Disposes of this error and frees any resources associated with it.
+    */
     virtual ~ProcessError();
+
+    /*!
+        /fn QProcess::ProcessError code()
+
+        Returns the code of the process error.
+    */
     QProcess::ProcessError code();
+
+    /*!
+        /fn QString phrase()
+
+        Returns a human readable explanation of the occurred process error.
+    */
     QString phrase();
+
+    /*!
+        /fn int exitCode()
+
+        Returns the exit code of the executed process.
+    */
     int exitCode();
+
+    /*!
+        /fn QString standardOut()
+
+        Returns the standard output of the executed process.
+    */
     QString standardOut();
+
+    /*!
+        /fn QString standardError()
+
+        Returns the standard error of the executed process.
+    */
     QString standardError();
+
+    /*!
+        /fn QString errorString() override
+
+        Returns a string representation of the error.
+    */
     QString errorString() override;
 
  protected:
+
+    /*!
+        Creates a new error from the provided process error struct.
+        \internal
+    */
     ProcessError(ProcessErrorStruct err, QObject* parent);
 
  private:
-    // use pimpl pattern so that users do not have to be recompiled
+    /*!
+        Use pimpl pattern so that users do not have to be recompiled
+        \internal
+    */
     ProcessErrorPrivate* d_ptr;
 };
 

=== modified file 'ubuntu-download-manager-client/ubuntu/download_manager/manager.h'
--- ubuntu-download-manager-client/ubuntu/download_manager/manager.h	2014-02-12 12:01:11 +0000
+++ ubuntu-download-manager-client/ubuntu/download_manager/manager.h	2014-03-19 19:29:24 +0000
@@ -36,9 +36,36 @@
 class Error;
 class GroupDownload;
 
+/*!
+    Callback to be executed that takes a download object created by
+    the manager.
+*/
 typedef std::function<void(Download*)> DownloadCb;
+
+/*!
+    Callback to be executed that takes a group download object created by
+    the manager.
+*/
 typedef std::function<void(GroupDownload*)> GroupCb;
 
+/*!
+    \class Manager
+    \brief The Manager class is the entry point of the download manager
+           API and allows the client to create download requests in the
+           download manager.
+    \since 0.3
+
+    The Manager is the entry point of the API and allows to create new
+    downloads that will be performed by the download manager. The
+    class allows to have two different types of managers:
+
+      - Session manager: Connects to the session dbus service.
+      - System manager: Connects to the system dbus service.
+
+    The general rule of thumb is that a normal client application must
+    connect to the session which contains all the downloads created for
+    the user in the current session.
+*/
 class DOWNLOAD_MANAGER_EXPORT Manager : public QObject {
     Q_OBJECT
 
@@ -46,36 +73,189 @@
     explicit Manager(QObject* parent = 0)
         : QObject(parent) {}
 
+    /*!
+        \fn void createDownload(DownloadStruct downStruct)
+
+        Creates a new download using the data found in the structure.
+        The \l void downloadCreated(Download* down) can be used to get
+        a pointer to the new created download.
+
+        \note The download object ownership from
+              \l void downloadCreated(Download* down) is of the caller and
+              the download manager will not delete it.
+    */
     virtual void createDownload(DownloadStruct downStruct) = 0;
+
+    /*!
+        \fn void createDownload(DownloadStruct downStruct, DownloadCb cb, DownloadCb errCb)
+
+        Creates a new download using the data found in the structure.
+        \a cb will be executed when a successful download creation occurs while
+        \a errCb will be executed when there was an error during the creation
+        of the download object.
+
+        \note Even when the callbacks are executed the
+              \l void downloadCreated(Download* down) is emitted.
+
+        \note The download object ownership from
+              \l void downloadCreated(Download* down) is of the caller and
+              the download manager will not delete it.
+    */
     virtual void createDownload(DownloadStruct downStruct,
                                 DownloadCb cb,
                                 DownloadCb errCb) = 0;
+
+    /*!
+        \fn void createDownload(StructList downs, const QString& algorithm, bool allowed3G, const QVariantMap& metadata, StringMap headers)
+
+        Creates a group download with the data found in the structure.
+        The \l void groupCreated(GroupDownload* down) signal can be used to
+        get a pointer to the new created group download.
+
+        \note The download object ownership from
+              \l void downloadCreated(Download* down) is of the caller and
+              the download manager will not delete it.
+    */
     virtual void createDownload(StructList downs,
-                                const QString &algorithm,
+                                const QString& algorithm,
                                 bool allowed3G,
-                                const QVariantMap &metadata,
+                                const QVariantMap& metadata,
                                 StringMap headers) = 0;
+
+    /*!
+        \fn void createDownload(StructList downs, const QString& algorithm, bool allowed3G, const QVariantMap& metadata, StringMap headers, GroupCb cb, GroupCb errCb)
+
+        Creates a group download with the data found in the structure.
+        \a cb will be executed when a successful group download creation
+        occurs while \a errCb will be executed when there was an error
+        during the creation of the group download object.
+
+        \note Even when the callbacks are executed the
+              \l void downloadCreated(Download* down) is emitted.
+
+        \note The download object ownership from
+              \l void downloadCreated(Download* down) is of the caller and
+              the download manager will not delete it.
+    */
     virtual void createDownload(StructList downs,
-                                const QString &algorithm,
+                                const QString& algorithm,
                                 bool allowed3G,
-                                const QVariantMap &metadata,
+                                const QVariantMap& metadata,
                                 StringMap headers,
                                 GroupCb cb,
                                 GroupCb errCb) = 0;
 
+    /*!
+        \fn bool isError() const
+
+        Returns if the manager received an error during the execution
+        of a command.
+    */
     virtual bool isError() const = 0;
+
+    /*!
+        \fn  Error* lastError() const
+
+        Returns the last error that occurred when interacting with the
+        download manager.
+    */
     virtual Error* lastError() const = 0;
+
+    /*!
+        \fn void Download::allowMobileDownload(bool allowed)
+
+        Allows to set a general setting that will ensure that all downloads
+        managed by the download manager are allowed to use the phones
+        mobile data or not.
+
+        \note Confined applications are not allowed to set this setting
+              and therefore an error would happen.
+    */
     virtual void allowMobileDataDownload(bool allowed) = 0;
+
+    /*!
+        \fn bool isMobileDownloadAllowed()
+
+        Returns if, as a general setting, the downloads created by the
+        download manager are allowed to use the phones mobile data.
+    */
     virtual bool isMobileDataDownload() = 0;
+
+    /*!
+        \fn qulonglong defaultThrottle()
+
+        Returns the default bandwidth limit that was set for the downloads
+        that are present in the download manager.
+    */
     virtual qulonglong defaultThrottle() = 0;
+
+    /*!
+        \fn void setDefaultThrottle(qulonglong speed)
+
+        Allows to set the default bandwidth limit to all the downloads in
+        the download manager.
+
+        \note Confined applications are not allowed to set this setting
+              and therefore an error would happen.
+    */
     virtual void setDefaultThrottle(qulonglong speed) = 0;
+
+    /*!
+        \fn void exit()
+
+        Allows to stop the download manager. This method should not be used
+        in production because it was added to simplify integration testing
+        with the download manager.
+
+        \note Confined applications are not allowed to set this setting
+              and therefore an error would happen.
+    */
     virtual void exit() = 0;
 
+    /*!
+        \fn static Manager* createSessionManager(const QString& path="", QObject* parent=0)
+
+        Creates a new manager that will be connected to the session manager.
+        \a path allows to provide the path where the download manager service
+        can be found. In the general use case \a path does not need to be
+        provided and the default value should be used.
+
+        \note \a path is exposed to allow integration tests with the download
+              manager by starting a download manager in a path and later
+              providing the path to the client library.
+    */
     static Manager* createSessionManager(const QString& path = "", QObject* parent=0);
+
+    /*!
+        \fn static Manager* createSystemManager(const QString& path = "", QObject* parent=0)
+
+        Creates a new manager that will be connected to the system manager.
+        \a path allows to provide the path where the download manager service
+        can be found. In the general use case \a path does not need to be
+        provided and the default value should be used.
+
+        \note \a path is exposed to allow integration tests with the download
+              manager by starting a download manager in a path and later
+              providing the path to the client library.
+    */
     static Manager* createSystemManager(const QString& path = "", QObject* parent=0);
 
  signals:
+
+    /*!
+        \fn void downloadCreated(Download* down)
+
+        This signal is emitted whenever a download is created by the
+        download manager.
+    */
     void downloadCreated(Download* down);
+
+    /*!
+        \fn void groupCreated(GroupDownload* down)
+
+        This signal is emitted whenever a group download is created by the
+        download manager.
+    */
     void groupCreated(GroupDownload* down);
 
 };

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/auth_error_struct.h'
--- ubuntu-download-manager-common/ubuntu/download_manager/auth_error_struct.h	2014-02-11 15:35:52 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/auth_error_struct.h	2014-03-19 19:29:24 +0000
@@ -27,36 +27,94 @@
 
 namespace DownloadManager {
 
+/*!
+    \class AuthErrorStruct 
+    \brief The AuthErrorStruct represents the dbus structure that is used
+           to communicate authentication errors that happened in the download
+           manager to the different clients.
+    \since 0.3
+*/
 class AuthErrorStruct {
     Q_PROPERTY(AuthErrorStruct::Type type READ getType)
     Q_PROPERTY(QString phrase READ getPhrase)
  public:
+
+    /*!
+        Enumerator that represents the error type.
+    */
     enum Type {
-        Server,
-        Proxy
+        Server, /*! The server needed authentication and it was not provided.*/
+        Proxy /*! The proxy needed authentication and it was not provided. */
     };
 
+    /*!
+        Creates a new structure with the default values.
+    */
     AuthErrorStruct();
+
+    /*!
+        Creates a new structure with the given error types and message.
+    */
     AuthErrorStruct(AuthErrorStruct::Type type, QString phrase);
+
+    /*!
+        Creates a new structure with the given error types and message.
+    */
     AuthErrorStruct(int type, QString phrase);
+
+    /*!
+        Copy constructor.
+    */
     AuthErrorStruct(const AuthErrorStruct& other);
+
+    /*!
+        Assign operator.
+    */
     AuthErrorStruct& operator=(const AuthErrorStruct& other);
 
+    /*!
+        \internal
+    */
     friend QDBusArgument &operator<<(QDBusArgument &argument,
         const AuthErrorStruct& error);
+
+    /*!
+        \internal
+    */
     friend const QDBusArgument &operator>>(const QDBusArgument &argument,
         AuthErrorStruct& error);
 
     // properties getters
+
+    /*!
+        \fn AuthErrorStruct::Type getType()
+
+        Returns the type of the error.
+    */
     AuthErrorStruct::Type getType();
+
+    /*!
+        \fn QString getPhrase()
+
+        Returns the message of the error.
+    */
     QString getPhrase();
 
  private:
+
+    /*!
+        \internal
+    */
     AuthErrorStruct::Type _type;
+
+    /*!
+        \internal
+    */
     QString _phrase;
 };
 
 }  // DownloadManager
 
 }  // Ubuntu
+
 #endif // AUTH_ERROR_STRUCT_H

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/download_struct.cpp'
--- ubuntu-download-manager-common/ubuntu/download_manager/download_struct.cpp	2014-02-07 11:16:15 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/download_struct.cpp	2014-03-19 19:29:24 +0000
@@ -79,9 +79,6 @@
     return *this;
 }
 
-DownloadStruct::~DownloadStruct() {
-}
-
 QDBusArgument &operator<<(QDBusArgument &argument,
                           const DownloadStruct& download) {
     argument.beginStructure();

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/download_struct.h'
--- ubuntu-download-manager-common/ubuntu/download_manager/download_struct.h	2014-02-07 11:20:13 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/download_struct.h	2014-03-19 19:29:24 +0000
@@ -30,6 +30,19 @@
 namespace DownloadManager {
 
 typedef QMap<QString, QString> StringList;
+
+/*!
+    \class DownloadStruct 
+    \brief The DownloadStruct represents the dbus structure that is used
+           to communicate the download manager the details of a new
+           download to be created.
+    \since 0.3
+
+    The DownloadStruct is the configuration structure that is sent to the
+    download manager specifying the different attribute of a download. This
+    attributes include from the url to be downloaded to the hash checksum
+    and the algorithm used for the checksum.
+*/
 class DOWNLOAD_MANAGER_EXPORT DownloadStruct {
     Q_PROPERTY(QString url READ getUrl)
     Q_PROPERTY(QString hash READ getHash)
@@ -38,37 +51,135 @@
     Q_PROPERTY(StringList headers READ getHeaders)
 
  public:
+    /*
+    */
     DownloadStruct();
+
+    /*
+       Creates a new download structure that will tell the download manager
+       to download the file found in the provided \q url with no metadata,
+       empty headers and without a checksum check.
+    */
     DownloadStruct(const QString& url);
+
+    /*
+       Creates a new download structure that will tell the download manager
+       to download the file found in the provided \a url with the given
+       \a metadata and \a headers but without a checksum check.
+    */
     DownloadStruct(const QString& url,
                    const QVariantMap& metadata,
                    const QMap<QString, QString>& headers);
+
+    /*
+       Creates a new download structure that will tell the download manager
+       to download the file found in the provided \a url with the given
+       \a metadata and \a headers. Once the file is download the checksum
+       check will be done against the provided \a hash using the specified
+       \a algorithm. The \a algorithm can be of one of the following string
+       values:
+
+         - "md5"
+         - "sha1"
+         - "sha224"
+         - "sha256"
+         - "sha384"
+         - "sha512"
+
+      \note If the hash provided is empty the download manager will assume
+            that there is no need to perform the checksum.
+      \note If the algorithm is an empty string or a not recognized value
+            md5 will be used.
+    */
     DownloadStruct(const QString& url,
                    const QString& hash,
                    const QString& algorithm,
                    const QVariantMap& metadata,
                    const QMap<QString, QString>& headers);
+
+    /*
+       Copy constructor.
+    */
     DownloadStruct(const DownloadStruct& other);
+
+    /*
+       Assign operator.
+    */
     DownloadStruct& operator=(const DownloadStruct& other);
-    ~DownloadStruct();
 
+    /*
+        \internal
+    */
     friend QDBusArgument &operator<<(QDBusArgument &argument,
         const DownloadStruct& download);
+
+    /*
+        \internal
+    */
     friend const QDBusArgument &operator>>(const QDBusArgument &argument,
         DownloadStruct& download);
 
-    // properties getters
+    /*
+       \fn QString getUrl()
+
+       Returns the url that points to the file that will be downloaded.
+    */
     QString getUrl();
+
+    /*
+       \fn QString getHash()
+
+       Returns the hash against which the checksum will be performed.
+    */
     QString getHash();
+
+    /*
+       \fn QString getAlgorithm()
+
+       Returns the algorithm that will be used to perform the checksum.
+    */
     QString getAlgorithm();
+
+    /*
+       \fn QVariantMap getMetadata()
+
+       Returns the metadata carried by the download.
+    */
     QVariantMap getMetadata();
+
+    /*
+       \fn QMap<QString, QString> getHeaders()
+
+       Returns the extra headers that will be used in the GET request of
+       the download.
+    */
     QMap<QString, QString> getHeaders();
 
  private:
+
+    /*
+        \internal
+    */
     QString _url;
+
+    /*
+        \internal
+    */
     QString _hash;
+
+    /*
+        \internal
+    */
     QString _algorithm;
+
+    /*
+        \internal
+    */
     QVariantMap _metadata;
+
+    /*
+        \internal
+    */
     QMap<QString, QString> _headers;
 };
 

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/group_download_struct.cpp'
--- ubuntu-download-manager-common/ubuntu/download_manager/group_download_struct.cpp	2014-02-13 17:26:17 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/group_download_struct.cpp	2014-03-19 19:29:24 +0000
@@ -53,10 +53,6 @@
     return *this;
 }
 
-GroupDownloadStruct::~GroupDownloadStruct() {
-}
-
-
 QDBusArgument &operator<<(QDBusArgument& argument,
                           const GroupDownloadStruct& group) {
     argument.beginStructure();
@@ -79,11 +75,6 @@
     return argument;
 }
 
-void GroupDownloadStruct::registerMetaType() {
-    qRegisterMetaType<GroupDownloadStruct>("GroupDownloadStruct");
-    qDBusRegisterMetaType<GroupDownloadStruct>();
-}
-
 QString
 GroupDownloadStruct::getUrl() const {
     return _url;

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/group_download_struct.h'
--- ubuntu-download-manager-common/ubuntu/download_manager/group_download_struct.h	2014-02-13 17:26:17 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/group_download_struct.h	2014-03-19 19:29:24 +0000
@@ -28,35 +28,99 @@
 
 namespace DownloadManager {
 
+/*!
+    \class GroupDownloadStruct 
+    \brief The GroupDownloadStruct represents a single download in a
+           group download that will be created in the download manager.
+    \since 0.3
+
+
+    Group downloads can be viewed as atomic operations that perform the
+    dowload of more than one file. This structure represents a single file
+    ins such a type of download and therefore exposes a subset of the
+    properties of a download.
+*/
 class DOWNLOAD_MANAGER_EXPORT GroupDownloadStruct {
     Q_PROPERTY(QString url READ getUrl)
     Q_PROPERTY(QString hash READ getHash)
     Q_PROPERTY(QString localFile READ getLocalFile)
 
  public:
+    /*!
+        Creates a new group download structure with the default values.
+    */
     GroupDownloadStruct();
+
+    /*!
+        Creates a new group download structure that will download a file
+        from \a url and will store it in the given \a localFile. The client
+        can provided the \a hash against which the checksum will be
+        performed.
+
+        \note if \a hash is empty the download manager will not check the
+              hash of the downloaded file.
+    */
     GroupDownloadStruct(const QString& url, const QString& localFile,
         const QString& hash);
+
+    /*!
+        Copy constructor.
+    */
     GroupDownloadStruct(const GroupDownloadStruct& other);
+
+    /*!
+        Assign operator.
+    */
     GroupDownloadStruct& operator=(const GroupDownloadStruct& other);
-    ~GroupDownloadStruct();
 
+    /*!
+        \internal
+    */
     friend QDBusArgument &operator<<(QDBusArgument &argument,
         const GroupDownloadStruct& group);
+
+    /*!
+        \internal
+    */
     friend const QDBusArgument &operator>>(const QDBusArgument &argument,
         GroupDownloadStruct& group);
 
-    // register Secret with the Qt type system
-    static void registerMetaType();
+    /*!
+        \fn getUrl() const
 
-    // property getters
+        Returns the url from which the download will be performed.
+    */
     QString getUrl() const;
+
+    /*!
+        \fn QString getHash() const
+
+        Returns the hash value against which the checksum will be performed.
+    */
     QString getHash() const;
+
+    /*!
+        \fn QString getLocalFile() const
+
+        Returns the local file where the download will be stored.
+    */
     QString getLocalFile() const;
 
  private:
+
+    /*!
+        \internal
+    */
     QString _url;
+
+    /*!
+        \internal
+    */
     QString _localFile;
+
+    /*!
+        \internal
+    */
     QString _hash;
 };
 

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/http_error_struct.cpp'
--- ubuntu-download-manager-common/ubuntu/download_manager/http_error_struct.cpp	2014-02-07 11:16:15 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/http_error_struct.cpp	2014-03-19 19:29:24 +0000
@@ -66,12 +66,12 @@
 }
 
 int
-HttpErrorStruct::getCode() {
+HttpErrorStruct::getCode() const {
     return _code;
 }
 
 QString
-HttpErrorStruct::getPhrase() {
+HttpErrorStruct::getPhrase() const {
     return _phrase;
 }
 

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/http_error_struct.h'
--- ubuntu-download-manager-common/ubuntu/download_manager/http_error_struct.h	2014-02-07 11:20:13 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/http_error_struct.h	2014-03-19 19:29:24 +0000
@@ -28,31 +28,81 @@
 
 namespace DownloadManager {
 
+/*!
+    \class HttpErrorStruct 
+    \brief The HttpErrorStruct represents the dbus structure that is used
+           to communicate http errors that happened in the download
+           manager to the different clients.
+    \since 0.3
+*/
 class DOWNLOAD_MANAGER_EXPORT HttpErrorStruct {
     Q_PROPERTY(int code READ getCode)
     Q_PROPERTY(QString phrase READ getPhrase)
+
  public:
+
+    /*!
+        Creates a new structure with the default values.
+    */
     HttpErrorStruct();
+
+    /*!
+        Creates a new structure with the given error types and message.
+    */
     HttpErrorStruct(int code, QString phrase);
+
+    /*!
+        Copy constructor.
+    */
     HttpErrorStruct(const HttpErrorStruct& other);
+
+    /*!
+        Assign operator.
+    */
     HttpErrorStruct& operator=(const HttpErrorStruct& other);
 
 
+    /*!
+        \internal
+    */
     friend QDBusArgument &operator<<(QDBusArgument &argument,
         const HttpErrorStruct& error);
+
+    /*!
+        \internal
+    */
     friend const QDBusArgument &operator>>(const QDBusArgument &argument,
         HttpErrorStruct& error);
 
-    // properties getters
-    int getCode();
-    QString getPhrase();
+    /*!
+        \fn int getCode() const
+
+        Returns the http error code.
+    */
+    int getCode() const;
+
+    /*!
+        \fn QString getPhrase() const
+
+        Returns a human readable message about the http error.
+    */
+    QString getPhrase() const;
 
  private:
+
+    /*!
+        \internal
+    */
     int _code;
+
+    /*!
+        \internal
+    */
     QString _phrase;
 };
 
 }  // DownloadManager
 
 }  // Ubuntu
+
 #endif // HTTP_ERROR_STRUCT_H

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/network_error_struct.cpp'
--- ubuntu-download-manager-common/ubuntu/download_manager/network_error_struct.cpp	2014-02-07 11:16:15 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/network_error_struct.cpp	2014-03-19 19:29:24 +0000
@@ -152,12 +152,12 @@
 }
 
 int
-NetworkErrorStruct::getCode() {
+NetworkErrorStruct::getCode() const {
     return _code;
 }
 
 QString
-NetworkErrorStruct::getPhrase() {
+NetworkErrorStruct::getPhrase() const {
     return _phrase;
 }
 

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/network_error_struct.h'
--- ubuntu-download-manager-common/ubuntu/download_manager/network_error_struct.h	2014-02-07 11:20:13 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/network_error_struct.h	2014-03-19 19:29:24 +0000
@@ -28,28 +28,81 @@
 
 namespace DownloadManager {
 
+/*!
+    \class NetworkErrorStruct 
+    \brief The NetworkErrorStruct represents the dbus structure that is used
+           to communicate network errors that happened in the download
+           manager to the different clients.
+    \since 0.3
+*/
 class DOWNLOAD_MANAGER_EXPORT NetworkErrorStruct {
     Q_PROPERTY(int code READ getCode)
     Q_PROPERTY(QString phrase READ getPhrase)
 
  public:
+
+    /*!
+        Creates a new structure with the default values.
+    */
     NetworkErrorStruct();
+
+    /*!
+        Creates an network error of the given type.
+    */
     NetworkErrorStruct(int error);
+
+    /*!
+        Creates a network error with the given type and a human readable
+        message.
+    */
     NetworkErrorStruct(int code, QString phrase);
+
+    /*!
+        Copy constructor.
+    */
     NetworkErrorStruct(const NetworkErrorStruct& other);
+
+    /*!
+        Assign operator.
+    */
     NetworkErrorStruct& operator=(const NetworkErrorStruct& other);
 
+    /*!
+        \internal
+    */
     friend QDBusArgument &operator<<(QDBusArgument &argument,
         const NetworkErrorStruct& error);
+
+    /*!
+        \internal
+    */
     friend const QDBusArgument &operator>>(const QDBusArgument &argument,
         NetworkErrorStruct& error);
 
-    // property getters
-    int getCode();
-    QString getPhrase();
+    /*!
+        \fn int getCode() const
+
+        Returns the type of network error.
+    */
+    int getCode() const;
+
+    /*!
+        \fn QString getPhrase const()
+
+        Returns a human readable message about the network error.
+    */
+    QString getPhrase() const;
 
  private:
+
+    /*!
+        \internal
+    */
     int _code;
+
+    /*!
+        \internal
+    */
     QString _phrase;
 };
 

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/process_error_struct.cpp'
--- ubuntu-download-manager-common/ubuntu/download_manager/process_error_struct.cpp	2014-02-07 11:16:15 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/process_error_struct.cpp	2014-03-19 19:29:24 +0000
@@ -128,27 +128,27 @@
 }
 
 int
-ProcessErrorStruct::getCode() {
+ProcessErrorStruct::getCode() const {
     return _code;
 }
 
 int
-ProcessErrorStruct::getExitCode() {
+ProcessErrorStruct::getExitCode() const {
     return _exitCode;
 }
 
 QString
-ProcessErrorStruct::getPhrase() {
+ProcessErrorStruct::getPhrase() const {
     return _phrase;
 }
 
 QString
-ProcessErrorStruct::getStandardOutput() {
+ProcessErrorStruct::getStandardOutput() const {
     return _stdout;
 }
 
 QString
-ProcessErrorStruct::getStandardError() {
+ProcessErrorStruct::getStandardError() const {
     return _stderr;
 }
 

=== modified file 'ubuntu-download-manager-common/ubuntu/download_manager/process_error_struct.h'
--- ubuntu-download-manager-common/ubuntu/download_manager/process_error_struct.h	2014-02-07 11:20:13 +0000
+++ ubuntu-download-manager-common/ubuntu/download_manager/process_error_struct.h	2014-03-19 19:29:24 +0000
@@ -28,6 +28,13 @@
 
 namespace DownloadManager {
 
+/*!
+    \class ProcessErrorStruct
+    \brief The ProcessErrorStruct represents the dbus structure that is used
+           to communicate process errors that happened in the download
+           manager to the different clients.
+    \since 0.3
+*/
 class DOWNLOAD_MANAGER_EXPORT ProcessErrorStruct {
     Q_PROPERTY(int code READ getCode)
     Q_PROPERTY(int exitCode READ getExitCode)
@@ -36,37 +43,123 @@
     Q_PROPERTY(QString READ getStandardError)
 
  public:
+
+    /*!
+        Creates a new structure with the default values.
+    */
     ProcessErrorStruct();
+
+    /*!
+        Create a new structure with the given error \a code and
+        a given human readable message.
+    */
     ProcessErrorStruct(int code, QString phrase);
+
+    /*!
+        Creates a new structure with the given error \a code and with
+        the exit details of the process. The process details are its
+        \a exitCode as well as the standard out via \a standardOut and
+        standard error via \a standarError
+    */
     ProcessErrorStruct(int code,
                        int exitCode,
                        QString standardOutput,
                        QString standardError);
+
+    /*!
+        Creates a new structure with the given error \a code , a human
+        readable message and with the exit details of the process.
+        The process details are its \a exitCode as well as the standard
+        out via \a standardOut and standard error via \a standarError
+    */
     ProcessErrorStruct(int code,
                        QString phrase,
                        int exitCode,
                        QString standardOutput,
                        QString standardError);
+
+    /*!
+        Copy constructor.
+    */
     ProcessErrorStruct(const ProcessErrorStruct& other);
+
+    /*!
+        Assign operator.
+    */
     ProcessErrorStruct& operator=(const ProcessErrorStruct& other);
 
+    /*!
+        \internal
+    */
     friend QDBusArgument &operator<<(QDBusArgument &argument,
         const ProcessErrorStruct& error);
+
+    /*!
+        \internal
+    */
     friend const QDBusArgument &operator>>(const QDBusArgument &argument,
         ProcessErrorStruct& error);
 
-    // property getters
-    int getCode();
-    int getExitCode();
-    QString getPhrase();
-    QString getStandardOutput();
-    QString getStandardError();
+    /*!
+        \fn int getCode() const
+
+        Returns the error code of the process.
+    */
+    int getCode() const;
+
+    /*!
+        \fn int getExitCode() const
+
+        Returns the exit code of the process.
+    */
+    int getExitCode() const;
+
+    /*!
+        \fn QString getPhrase() const
+
+        Returns a human readable message of the occurred error.
+    */
+    QString getPhrase() const;
+
+    /*!
+        \fn QString getStandardOutput() const
+
+        Returns the standard output of the process.
+    */
+    QString getStandardOutput() const;
+
+    /*!
+        \fn QString getStandardError() const
+
+        Returns the standard error of the process.
+    */
+    QString getStandardError() const;
 
  private:
+
+    /*!
+        \internal
+    */
     int _code;
+
+    /*!
+        \internal
+    */
     int _exitCode;
+
+    /*!
+        \internal
+    */
     QString _phrase;
+
+    /*!
+        \internal
+    */
     QString _stdout;
+
+    /*!
+        \internal
+    */
     QString _stderr;
 };