Merge lp:~michihenning/storage-framework/add-client-doc into lp:storage-framework/devel

[Michi Henning]

Partial reference doc for qt V2 API.

Partial reference doc for qt V2 API.

[unity-api-1-bot (unity-api-1-bot)]

PASSED: Continuous integration, rev:137
https://jenkins.canonical.com/unity-api-1/job/lp-storage-framework-ci/286/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build/1932
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-0-fetch/1939
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/1719
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=xenial+overlay/1719/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=zesty/1719
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=amd64,release=zesty/1719/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=xenial+overlay/1719
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=xenial+overlay/1719/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=zesty/1719
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=armhf,release=zesty/1719/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/1719
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=xenial+overlay/1719/artifact/output/*zip*/output.zip
    SUCCESS: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=zesty/1719
        deb: https://jenkins.canonical.com/unity-api-1/job/build-2-binpkg/arch=i386,release=zesty/1719/artifact/output/*zip*/output.zip

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-storage-framework-ci/286/rebuild

review: Approve (continuous-integration)

[James Henstridge (jamesh)]

Looks good.

review: Approve

=== modified file 'doc/CMakeLists.txt'
--- doc/CMakeLists.txt	2017-03-30 06:31:03 +0000
+++ doc/CMakeLists.txt	2017-04-21 01:35:48 +0000
@@ -11,7 +11,7 @@
         ${CMAKE_SOURCE_DIR}/include
     EXCLUDE_PATTERNS
         */internal/*
-        */qt/*
+        */registry/*
     ALL
 )
 

=== renamed file 'doc/provider_tut.dox' => 'doc/tutorial.dox'
--- doc/provider_tut.dox	2017-04-05 04:06:39 +0000
+++ doc/tutorial.dox	2017-04-21 01:35:48 +0000
@@ -133,6 +133,8 @@
 If a provider supplies non-standard metadata items, the item keys have a provider-specific prefix, such as
 <tt>mcloud:</tt> or <tt>gdrive:</tt>.
 
+Do not use hard-wired string literals as keys; instead use the symbolic constants defined in \ref common.h.
+
 \subsection uploads-downloads Uploads and Downloads
 
 Uploads and downloads take place over a UNIX domain socket. When a client requests an upload, the runtime creates
@@ -576,13 +578,37 @@
 aggressively you try to resume though; on a battery-powered device, it is expensive to turn on the radio, so you
 should use a back-off algorithm and give up if the upload cannot be resumed within a reasonable period of time.)
 
-\section local-provider The Local Provider
+\section client Implementing a Client
+
+This section provides an overview of the client API and explains the semantics you can expect when interacting
+with a provider.
+
+\subsection client-overview Overview
+
+\page local-provider The Local Provider
 
 The storage framework includes a local provider that stores files in the local file system.
-In a classic environment, the root of the local files is <code>$XDG_DATA_DIR/storage-framework/local</code>;
-in a Snap environment, the root is <code>$SNAP_USER_COMMON/storage-framework/local</code>.
+The default root for local files is
+- <code>$XDG_DATA_DIR/storage-framework/local</code> (classic environment)
+- <code>$SNAP_USER_COMMON/storage-framework/local</code> (snap environment)
+
 You can set <code>$SF_LOCAL_PROVIDER_ROOT</code> to change the root directory. (This is intended mainly for testing.)
 
 The local provider uses <code>com.canonical.StorageFramework.Provider.Local</code> as the DBus name. The object path
 is <code>/provider/0</code>.
+
+\page environment-variables Environment Variables
+The storage framework uses the following environment variables.
+- <code>SF_REGISTRY_IDLE_TIMEOUT</code><br>
+  The idle timeout for the storage framework registry, in seconds. The default value is 30 seconds.<br>
+  Setting this variable to 0 disables the idle timeout.
+- <code>SF_PROVIDER_IDLE_TIMEOUT</code><br>
+  The idle timeout for providers, in seconds. The default value is 30 seconds.<br>
+  Setting this variable to 0 disables the idle timeout.
+- <code>SF_LOCAL_PROVIDER_ROOT</code><br>
+  The root directory for files accessed via the \link local-provider local provider\endlink.
+  (This is intended for testing.)<br>
+  If not set, the default value is
+ - <code>$XDG_DATA_DIR/storage-framework/local</code> (classic environment)
+ - <code>$SNAP_USER_COMMON/storage-framework/local</code> (snap environment)
 */

=== modified file 'include/unity/storage/common.h'
--- include/unity/storage/common.h	2017-03-29 01:01:24 +0000
+++ include/unity/storage/common.h	2017-04-21 01:35:48 +0000
@@ -18,8 +18,14 @@
 
 #pragma once
 
+/**
+\brief Top-level namespace for all things Unity-related.
+*/
 namespace unity
 {
+/**
+\brief Top-level namespace for the storage framework API.
+*/
 namespace storage
 {
 

=== modified file 'include/unity/storage/provider/ProviderBase.h'
--- include/unity/storage/provider/ProviderBase.h	2017-04-05 00:56:00 +0000
+++ include/unity/storage/provider/ProviderBase.h	2017-04-21 01:35:48 +0000
@@ -36,6 +36,9 @@
 {
 namespace storage
 {
+/**
+\brief This namespace contains the provider API.
+*/
 namespace provider
 {
 

=== modified file 'include/unity/storage/qt/Account.h'
--- include/unity/storage/qt/Account.h	2016-11-28 11:04:17 +0000
+++ include/unity/storage/qt/Account.h	2017-04-21 01:35:48 +0000
@@ -40,54 +40,172 @@
 class ItemJob;
 class ItemListJob;
 
+/**
+Class th provides access to account details.
+
+Note that this class is an immutable value type: if you retrieve the details of an account, and
+those details change in Online Accounts later, the change is not reflected in the Account
+instance you retrieved earlier. To get the updated details, you must retrieve the latest
+list of accounts again by calling Runtime::accounts() and use the accounts returned
+by the corresponding AccountsJob.
+*/
+
 class Q_DECL_EXPORT Account final
 {
     Q_GADGET
+    /**
+    \see \link isValid() const isValid()\endlink
+    */
     Q_PROPERTY(bool isValid READ isValid FINAL)
+
+    /**
+    \see \link busName() const busName()\endlink
+    */
     Q_PROPERTY(QString busName READ busName FINAL)
+
+    /**
+    \see \link objectPath() const objectPath()\endlink
+    */
     Q_PROPERTY(QString objectPath READ objectPath FINAL)
+
+    /**
+    \see \link displayName() const displayName()\endlink
+    */
     Q_PROPERTY(QString displayName READ displayName FINAL)
+
+    /**
+    \see \link providerName() const providerName()\endlink
+    */
     Q_PROPERTY(QString providerName READ providerName FINAL)
+
+    /**
+    \see \link iconName() const iconName()\endlink
+    */
     Q_PROPERTY(QString iconName READ iconName FINAL)
 
 public:
+    /**
+    \brief Constructs an account.
+
+    A default-constructed Account returns <code>false</code> from isValid(), and the remaining accessors return
+    the empty string.
+    */
     Account();
+
+    /**
+    \brief Destroys an account.
+    */
+    ~Account();
+
+    /** @name Copy and assignment
+    Copy and assignment operators (move and non-move versions) have the usual value semantics.
+    */
+    //{@
     Account(Account const&);
     Account(Account&&);
-    ~Account();
     Account& operator=(Account const&);
     Account& operator=(Account&&);
+    //@}
 
+    /**
+    \brief Checks whether this account was successfully constructed.
+    \return Returns <code>true</code> if the account contains valid details; <code>false</code> otherwise.
+    */
     bool isValid() const;
+
+    /**
+    \brief Returns the DBus name of the corresponding provider.
+    \return The DBus name or the empty string if isValid() returns <code>false</code>.
+    */
     QString busName() const;
+
+    /**
+    \brief Returns the DBus object path of the corresponding provider.
+    \return The DBus object path or the empty string if isValid() returns <code>false</code>.
+    */
     QString objectPath() const;
+
+    /**
+    \brief Returns the display name of the account.
+    \return The display name (such as "[e-mail]") or the empty string if isValid() returns <code>false</code>.
+    */
     QString displayName() const;
+
+    /**
+    \brief Returns the name of the provider for the account.
+    \return The provider name (such as "Nextcloud") or the empty string if isValid() returns <code>false</code>.
+    */
     QString providerName() const;
+
+    /**
+    \brief Returns the name of an icon file.
+    \return The name of a file containing an icon image or the empty string if isValid() returns <code>false</code>.
+    */
     QString iconName() const;
 
+    /**
+    \brief Retrieves the list of available roots.
+    \param keys A list of metadata keys for metadata items that should be returned by the provider.
+    If the list is empty, the provider returns a default set of metadata items.
+    \return An ItemListJob that, once complete, provides access to the available roots.
+    \note You <i>must</i> deallocate the returned job by calling <code>delete</code>.
+    \see Item, \link metadata Metadata\endlink
+    */
     Q_INVOKABLE unity::storage::qt::ItemListJob* roots(QStringList const& keys = QStringList()) const;
+
+    /**
+    \brief Retrieves an item by identity.
+    \return An ItemJob that, once complete, provides access to the item's details.
+    \note You <i>must</i> deallocate the returned job by calling <code>delete</code>.
+    \see Item
+    */
     Q_INVOKABLE unity::storage::qt::ItemJob* get(QString const& itemId, QStringList const& keys = QStringList()) const;
 
-    bool operator==(Account const&) const;
+    /** @name Comparison operators and hashing
+    */
+    //{@
+    /**
+    \brief Compares Account instances for equality.
+
+    Account instances are equal if both are invalid or both are valid and all their details
+    (bus name, object path, display name, provider name, and icon name) are equal.
+    \param other The account to compare this account with.
+    \return If all details of the accounts match, <code>true</code> is returned; <code>false</code> otherwise.
+    */
+    bool operator==(Account const& other) const;
     bool operator!=(Account const&) const;
     bool operator<(Account const&) const;
     bool operator<=(Account const&) const;
     bool operator>(Account const&) const;
     bool operator>=(Account const&) const;
 
+    /**
+    \brief Returns a hash value.
+    \note The hash value is <i>not</i> necessarily the same as the one returned by
+    \link unity::storage::qt::qHash(Account const& acc) qHash()\endlink, but <i>is</i> the same as the one returned by
+    \link std::hash<unity::storage::qt::Account> std::hash<Account>()\endlink.
+    \return A hash value for use with unordered containers.
+    */
     size_t hash() const;
+    //@}
 
 private:
+    ///@cond
     Account(std::shared_ptr<internal::AccountImpl> const& p);
 
     std::shared_ptr<internal::AccountImpl> p_;
 
     friend class internal::AccountImpl;
     friend class internal::ItemImpl;
+    ///@endcond
 };
 
-// Note: qHash(Account) does *not* return the same hash value is std::hash<Account> because
-//       std:hash() returns size_t (typically 64 bits), but qHash() returns uint (typically 32 bits).
+/**
+\brief Returns a hash value.
+\note The hash value is <i>not</i> necessarily the same as the one returned by
+\link Account::hash()\endlink.
+\return A hash value for use with unordered containers.
+*/
 uint Q_DECL_EXPORT qHash(Account const& acc);
 
 }  // namespace qt
@@ -100,8 +218,20 @@
 namespace std
 {
 
+/**
+\brief Function template specialization in namespace <code>std</code> to allow use of
+\link unity::storage::qt::Account Account\endlink instances with unordered containers.
+*/
 template<> struct Q_DECL_EXPORT hash<unity::storage::qt::Account>
 {
+    /**
+    \brief Returns a hash value.
+    \note The hash value is <i>not</i> necessarily the same as the one returned by
+    \link unity::storage::qt::qHash(const Account& acc) qHash()\endlink (but <i>is</i> the same as the value returned
+    by \link unity::storage::qt::Account::hash() Account::hash()\endlink).
+    \return A hash value for use with unordered containers.
+    \see \link unity::storage::qt::Account::hash Account::hash()\endlink
+    */
     std::size_t operator()(unity::storage::qt::Account const& a) const
     {
         return a.hash();

=== modified file 'include/unity/storage/qt/AccountsJob.h'
--- include/unity/storage/qt/AccountsJob.h	2016-11-15 02:05:14 +0000
+++ include/unity/storage/qt/AccountsJob.h	2017-04-21 01:35:48 +0000
@@ -40,29 +40,93 @@
 class Account;
 class StorageError;
 
+/**
+\brief Asynchronous job to retrieve a list of accounts.
+*/
+
 class Q_DECL_EXPORT AccountsJob final : public QObject
 {
     Q_OBJECT
+
+    /**
+    \see \link isValid() const isValid()\endlink
+    */
     Q_PROPERTY(bool isValid READ isValid NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link status() const status()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::AccountsJob::Status status READ status NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link error() const error()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::StorageError error READ error NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link accounts() const accounts()\endlink
+    */
     Q_PROPERTY(QVariantList accounts READ accountsAsVariantList NOTIFY statusChanged FINAL)
 
 public:
-    enum Status { Loading, Finished, Error };
+    /**
+    \brief Indicates the status of the job.
+    */
+    enum Status {
+        Loading,   /*!< The job is still executing. */
+        Finished,  /*!< The job finished succesfully. */
+        Error      /*!< The job finished with an error. */
+    };
     Q_ENUMS(Status)
 
+    /**
+    \brief Destroys the job.
+
+    It is safe to destroy a job while it is still executing.
+    */
     virtual ~AccountsJob();
 
+    /**
+    \brief Returns whether this job was successfully created.
+    \return If the job status is \link Error\endlink, the return value is <code>false</code>;
+    <code>true</code> otherwise.
+    */
     bool isValid() const;
+
+    /**
+    \brief Returns the current job status.
+    \return The job status.
+    */
     Status status() const;
+
+    /**
+    \brief Returns the last error that occured in this job.
+    \return A StorageError that indicates the cause of the error if isValid() returns <code>false</code>.
+    If isValid() returns <code>true</code>, the returned StorageError has type StorageError::NoError.
+    */
     StorageError error() const;
+
+    /**
+    \brief Returns the list of accounts.
+    \return The list of accounts or an empty list if the status is not \link Finished\endlink.
+    */
     QList<Account> accounts() const;
 
 Q_SIGNALS:
+    //@}
+
+    /** @name Signals
+    */
+    //{@
+    /**
+    \brief This signal is emitted whenever this job transitions to the \link Finished\endlink or \link Error\endlink state.
+    \param status The status of the job.
+    */
     void statusChanged(unity::storage::qt::AccountsJob::Status status) const;
+    //@}
 
 private:
+    ///@cond
     AccountsJob(std::unique_ptr<internal::AccountsJobImpl> accounts_job_impl);
 
     QVariantList accountsAsVariantList() const;
@@ -70,6 +134,7 @@
     std::unique_ptr<internal::AccountsJobImpl> const p_;
 
     friend class internal::AccountsJobImpl;
+    ///@endcond
 };
 
 }  // namespace qt

=== modified file 'include/unity/storage/qt/Downloader.h'
--- include/unity/storage/qt/Downloader.h	2017-04-21 01:35:48 +0000
+++ include/unity/storage/qt/Downloader.h	2017-04-21 01:35:48 +0000
@@ -36,16 +36,45 @@
 
 }  // namespace internal
 
+/**
+\brief Class to download the contents of a file.
+*/
+
 class Q_DECL_EXPORT Downloader final : public QIODevice
 {
     Q_OBJECT
+
+    /**
+    \see \link isValid() const isValid()\endlink
+    */
     Q_PROPERTY(bool isValid READ isValid NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link status() const status()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::Downloader::Status status READ status NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link error() const error()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::StorageError error READ error NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link item() const item()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::Item item READ item NOTIFY statusChanged FINAL)
 
 public:
-    enum Status { Loading, Ready, Cancelled, Finished, Error };
+    /**
+    \brief Indicates the status of the job.
+    */
+    enum Status {
+        Loading,   /*!< The job is still executing. */
+        Ready,     /*!< The job is ready for reading data. */
+        Cancelled, /*!< The job was cancelled. */
+        Finished,  /*!< The job finished succesfully. */
+        Error      /*!< The job finished with an error. */
+    };
     Q_ENUMS(Status)
 
     virtual ~Downloader();
@@ -67,9 +96,18 @@
     Q_INVOKABLE bool waitForReadyRead(int msecs = 30000) override;
 
 Q_SIGNALS:
+    /** @name Signals
+    */
+    //{@
+    /**
+    \brief This signal is emitted whenever this job transitions to a new state.
+    \param status The status of the job.
+    */
     void statusChanged(unity::storage::qt::Downloader::Status status) const;
+    //@}
 
 private:
+    ///@cond
     Downloader(std::unique_ptr<internal::DownloaderImpl> p);
 
     qint64 readData(char* data, qint64 c);
@@ -78,6 +116,7 @@
     std::unique_ptr<internal::DownloaderImpl> p_;
 
     friend class internal::DownloaderImpl;
+    ///@endcond
 };
 
 }  // namespace qt

=== modified file 'include/unity/storage/qt/Item.h'
--- include/unity/storage/qt/Item.h	2016-11-03 07:33:40 +0000
+++ include/unity/storage/qt/Item.h	2017-04-21 01:35:48 +0000
@@ -52,85 +52,369 @@
 class Uploader;
 class VoidJob;
 
+/**
+Class that provides access to a file or folder.
+
+Item provides access to the details of a file or folder, such as its identity, name, etc.
+It also provides operations to, for example, create or destroy files or folders, and to
+initiate uploads and downloads.
+
+Note that this class is an immutable value type: if you retrieve the details of an item, and
+those details change due to other operations being performed on the item, any changes are <i>not</i> reflected
+by the Item instance you retrieved earlier. Each operation that potentially modifies the state of an item
+also returns the new update item once it completes, so you can assign the update item to the original item or,
+alternatively, simply let the original item go out scope after initiating an operation.
+*/
+
 class Q_DECL_EXPORT Item final
 {
     Q_GADGET
+
+    /**
+    \see \link itemId() const itemId()\endlink
+    */
     Q_PROPERTY(QString itemId READ itemId FINAL)
+
+    /**
+    \see \link name() const name()\endlink
+    */
     Q_PROPERTY(QString name READ name FINAL)
+
+    /**
+    \see \link account() const account()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::Account account READ account FINAL)
+
+    /**
+    \see \link etag() const etag()\endlink
+    */
     Q_PROPERTY(QString etag READ etag FINAL)
+
+    /**
+    \see \link type() const type()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::Item::Type type READ type FINAL)
+
+    /**
+    \see \link metadata() const metadata()\endlink
+    */
     Q_PROPERTY(QVariantMap metadata READ metadata FINAL)
+
+    /**
+    \see \link lastModifiedTime() const lastModifiedTime()\endlink
+    */
     Q_PROPERTY(QDateTime lastModifiedTime READ lastModifiedTime FINAL)
+
+    /**
+    \see \link parentIds() const parentIds()\endlink
+    */
     Q_PROPERTY(QStringList parentIds READ parentIds FINAL)
 
 public:
+    /**
+    \brief Constructs an item.
+
+    A default-constructed Item returns <code>false</code> from isValid(), and the remaining accessors return
+    default-constructed values.
+    */
     Item();
+
+    /**
+    \brief Destroys an item.
+    */
+    ~Item();
+
+    /** @name Copy and assignment
+    \brief Copy and assignment operators (move and non-move versions) have the usual value semantics.
+    */
+    //{@
     Item(Item const&);
     Item(Item&&);
-    ~Item();
     Item& operator=(Item const&);
     Item& operator=(Item&&);
+    //@}
 
+    /**
+    \brief Indicates the type of the item.
+    */
     enum Type
     {
-        File = unsigned(unity::storage::ItemType::file),
-        Folder = unsigned(unity::storage::ItemType::folder),
-        Root = unsigned(unity::storage::ItemType::root)
+        File /** @cond */ = unsigned(unity::storage::ItemType::file) /** @endcond */,     /*!< The item is a file. */
+        Folder /** @cond */ = unsigned(unity::storage::ItemType::folder) /** @endcond */, /*!< The item is a folder. */
+        Root /** @cond */ = unsigned(unity::storage::ItemType::root) /** @endcond */      /*!< The item is a root folder. */
     };
     Q_ENUMS(Type)
 
+    /**
+    \brief Indicates how the provider should respond in case of an ETag mismatch.
+    */
     enum ConflictPolicy
     {
-        ErrorIfConflict = unsigned(unity::storage::ConflictPolicy::error_if_conflict),
-        IgnoreConflict = unsigned(unity::storage::ConflictPolicy::ignore_conflict)
+        ErrorIfConflict /** @cond */
+            = unsigned(unity::storage::ConflictPolicy::error_if_conflict) /** @endcond */, /*!< Fail the operation. */
+        IgnoreConflict /** @cond */
+            = unsigned(unity::storage::ConflictPolicy::ignore_conflict)   /** @endcond */  /*!< Ignore the ETag mismatch. */
     };
     Q_ENUMS(ConflictPolicy)
 
+    /** @name Accessors
+    */
+    //{@
+
+    /**
+    \brief Checks whether this item was successfully constructed.
+    \return Returns <code>true</code> if the item contains valid details; <code>false</code> otherwise.
+    */
     bool isValid() const;
+
+    /**
+    \brief Returns the identity of the item.
+
+    Identities are unique only within their corresponding account, so items belong to different accounts may
+    have the same identity. If an item is destroyed, it is possible for a different item that is created later
+    to get the destroyed item's identity.
+    \return The identity of the item.
+    \see \link identity File and Folder Identity\endlink
+    */
     QString itemId() const;
+
+    /**
+    \brief Returns the name of the item.
+
+    Providers may silently modify the name of files and folders that are created. (For example, a provider
+    may map upper-case letters to lower-case.) After creating an item,
+    always call name() to obtain the actual name of the item.
+    \return The item's name.
+    \see \link names File and Folder Names\endlink
+    */
     QString name() const;
+
+    /**
+    \brief Returns the account for the item.
+    \return The item's account.
+    \see \link accounts Accounts\endlink
+    */
     Account account() const;
+
+    /**
+    \brief Returns the ETag of the item.
+    \return The item's ETag.
+    \see \link etags ETags\endlink
+    */
     QString etag() const;
+
+    /**
+    \brief Returns the type of the item.
+    \return The item's type
+    */
     Type type() const;
+
+    /**
+    \brief Returns the metadata for the item.
+    \return The item's metadata
+    \see \link metadata Metadata\endlink
+    */
     QVariantMap metadata() const;
+
+    /**
+    \brief Returns the size in bytes of a file.
+    \return The file size. If the item is not a file, the return value is 0.
+    */
     qint64 sizeInBytes() const;
+
+    /**
+    \brief Returns the time at which the item was last modified.
+    \return The item's modification time. For files, the modification time is always available.
+    Some providers do not support modification time stamps for folders. If so, the returned
+    time is invalid.
+    */
     QDateTime lastModifiedTime() const;
+
+    /**
+    \brief Returns the identity of the item's parent folders.
+    \return The item's parent identities.
+    */
     QStringList parentIds() const;
+    //@}
 
+    /** @name Operations
+    All operations are asynchronous and return a job that, once complete, provides the return value
+    or error information.
+    \note You <i>must</i> deallocate the returned instance by calling <code>delete</code> (or, alternatively,
+    call <a href="http://doc.qt.io/qt-5/qobject.html#setParent">setParent()</a> to re-parent the job).
+    Failing to do so causes a memory leak!
+    */
+    //{@
+    /**
+    \brief Creates a job that retrieves the parent folders of this item.
+    \return A job that, once complete, provides access to the parent folders.
+    */
     Q_INVOKABLE unity::storage::qt::ItemListJob* parents(QStringList const& keys = QStringList()) const;
+
+    /**
+    \brief Copies this file or folder.
+
+    Copying is recursive. If you copy a folder, all it's contents are copied.
+
+    You can copy files and folders only within the same account.
+    \param newParent The parent folder for this item. If you want to copy this item within
+    the same parent folder, <code>newParent</code> must be the same as this item's current parent.
+    \param newName The new name for this item within its <code>newParent</code> folder.
+    \param keys A list of metadata keys for metadata items that should be returned by the provider.
+    If the list is empty, the provider returns a default set of metadata items.
+    \return A job that, once complete, provides access to the copied item.
+    */
     Q_INVOKABLE unity::storage::qt::ItemJob* copy(Item const& newParent,
                               QString const& newName,
                               QStringList const& keys = QStringList()) const;
+
+    /**
+    \brief Moves and/or rename this file or folder.
+
+    You can move files and folders only within the same account.
+    \param newParent The parent folder for this item. If you want to rename this item within
+    the same parent folder, <code>newParent</code> must be the same as this item's current parent.
+    \param newName The new name for this item within its <code>newParent</code> folder.
+    \param keys A list of metadata keys for metadata items that should be returned by the provider.
+    If the list is empty, the provider returns a default set of metadata items.
+    \return A job that, once complete, provides access to the copied item.
+    */
     Q_INVOKABLE unity::storage::qt::ItemJob* move(Item const& newParent,
                               QString const& newName,
                               QStringList const& keys = QStringList()) const;
+
+    /**
+    \brief Deletes this item.
+
+    Deletion is recursive. If this item is a folder, all it's contents are deleted as well.
+
+    You cannot delete a root folder.
+    \return A job that, once complete, provides access to a StorageError (if any).
+    */
     Q_INVOKABLE unity::storage::qt::VoidJob* deleteItem() const;
 
+    /**
+    \brief Creates an uploader for this file.
+
+    Attempts to upload to a folder return an uploader that indicates an error.
+    \param policy If set to <code>ErrorIfConflict</code>, the upload job indicates an error if this file's
+    ETag no longer matches the ETag maintained by the provider. If set to <code>IgnoreConflict</code>, this
+    file's contents are overwritten.
+    \param sizeInBytes The size of the upload. You must write <i>exactly</i> that number of bytes to the upload
+    socket before finalizing the upload. If the <code>sizeInBytes</code> does not match the size of the
+    actually uploaded data, the upload will fail.
+    \param keys A list of metadata keys for metadata items that should be returned by the provider.
+    If the list is empty, the provider returns a default set of metadata items.
+    \return An uploader that, once ready, can be used to upload the data for this file.
+    \see \link uploads-downloads Uploads and Downloads\endlink
+    */
     Q_INVOKABLE unity::storage::qt::Uploader* createUploader(ConflictPolicy policy,
                                                              qint64 sizeInBytes,
                                                              QStringList const& keys = QStringList()) const;
+
+    /**
+    \brief Creates a downloader for this file.
+
+    Attempts to download a folder return a downloader that indicates an error.
+    \param policy If set to <code>ErrorIfConflict</code>, the download job indicates an error if this file's
+    ETag no longer matches the ETag maintained by the provider. If set to <code>IgnoreConflict</code>, the
+    download will proceed regardless of any ETag mismatch.
+    \return A downloader that, once ready, can be used to download the data for this file.
+    \see \link uploads-downloads Uploads and Downloads\endlink
+    */
     Q_INVOKABLE unity::storage::qt::Downloader* createDownloader(ConflictPolicy policy) const;
 
+    /**
+    \brief Lists the contents of this folder.
+
+    Attempts to list a file return a job that indicates an error.
+    \param keys A list of metadata keys for metadata items that should be returned by the provider.
+    If the list is empty, the provider returns a default set of metadata items.
+    \return A job that, once complete, provides access to this folder's items.
+    */
     Q_INVOKABLE unity::storage::qt::ItemListJob* list(QStringList const& keys = QStringList()) const;
-    Q_INVOKABLE unity::storage::qt::ItemListJob* lookup(QString const& name, QStringList const& = QStringList()) const;
-    Q_INVOKABLE unity::storage::qt::ItemJob* createFolder(QString const& name, QStringList const& = QStringList()) const;
+
+    /**
+    \brief Locates an item by name within this folder.
+
+    Attempts to perform a lookup on a file return a job that indicates an error.
+    \param name The name of the item to look up.
+    \param keys A list of metadata keys for metadata items that should be returned by the provider.
+    If the list is empty, the provider returns a default set of metadata items.
+    \return A job that, once complete, provides access to the items with the given <code>name</code>.
+    */
+    Q_INVOKABLE unity::storage::qt::ItemListJob* lookup(QString const& name,
+                                                        QStringList const& keys = QStringList()) const;
+
+    /**
+    \brief Creates a child folder within this folder.
+
+    Attempts to create a folder within a file return a job that indicates an error.
+    \param name The name of the new folder within this folder.
+    \param keys A list of metadata keys for metadata items that should be returned by the provider.
+    If the list is empty, the provider returns a default set of metadata items.
+    \return A job that, once complete, provides access to the new folder.
+    */
+    Q_INVOKABLE unity::storage::qt::ItemJob* createFolder(QString const& name,
+                                                          QStringList const& keys = QStringList()) const;
+
+    /**
+    \brief Creates a file within this folder.
+
+    The number of bytes written via the returned uploader <i>must</i> match <code>sizeInBytes</code>, otherwise
+    the upload will indicate an error.
+
+    Attempts to create a file within a file return a job that indicates an error.
+    \param name The name of the new file within this folder.
+    \param policy If set to <code>ErrorIfConflict</code>, the upload job indicates an error if this file's
+    ETag no longer matches the ETag maintained by the provider. If set to <code>IgnoreConflict</code>, any
+    existing file with the same name is overwritten.
+    \param sizeInBytes The number of bytes that the client will upload for this file.
+    \param contentType The <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">media type</a>
+    of the file. Note that providers may ignore this parameter and determine the media type
+    themselves (based on the file name or the file contents).
+    \param keys A list of metadata keys for metadata items that should be returned by the provider.
+    If the list is empty, the provider returns a default set of metadata items.
+    \return An uploader that, once ready, can be used to upload the data for this file.
+    \see \link uploads-downloads Uploads and Downloads\endlink
+    */
     Q_INVOKABLE unity::storage::qt::Uploader* createFile(QString const& name,
                                                          ConflictPolicy policy,
                                                          qint64 sizeInBytes,
                                                          QString const& contentType,
                                                          QStringList const& keys = QStringList()) const;
-
-    bool operator==(Item const&) const;
+    //@}
+
+    /** @name Comparison operators and hashing.
+    */
+    //{@
+    /**
+    \brief Compares Item instances for equality.
+
+    Item instances are equal if both are invalid, or both are valid, use the same account,
+    and have the same identity.
+    \param other The item to compare this item with.
+    \return If all details of the items match, <code>true</code> is returned; <code>false</code> otherwise.
+    */
+    bool operator==(Item const& other) const;
     bool operator!=(Item const&) const;
     bool operator<(Item const&) const;
     bool operator<=(Item const&) const;
     bool operator>(Item const&) const;
     bool operator>=(Item const&) const;
 
+    /**
+    \brief Returns a hash value.
+    \note The hash value is <i>not</i> necessarily the same as the one returned by
+    \link unity::storage::qt::qHash(Item const& i) qHash()\endlink, but <i>is</i> the same as the one returned by
+    \link std::hash<unity::storage::qt::Item> Item::hash()\endlink.
+    \return A hash value for use with unordered containers.
+    */
     size_t hash() const;
+    //@}
 
 private:
+    ///@cond
     Item(std::shared_ptr<internal::ItemImpl> const&);
 
     std::shared_ptr<internal::ItemImpl> p_;
@@ -138,10 +422,15 @@
     friend class internal::ItemImpl;
     friend class internal::DownloaderImpl;
     friend class internal::UploaderImpl;
+    ///@endcond
 };
 
-// Note: qHash(Item) does *not* return the same hash value is std::hash<Item> because
-//       std:hash() returns size_t (typically 64 bits), but qHash() returns uint (typically 32 bits).
+/**
+\brief Returns a hash value.
+\note The hash value is <i>not</i> necessarily the same as the one returned by
+\link Item::hash()\endlink.
+\return A hash value for use with unordered containers.
+*/
 uint Q_DECL_EXPORT qHash(unity::storage::qt::Item const& i);
 
 }  // namespace qt
@@ -156,8 +445,20 @@
 namespace std
 {
 
+/**
+\brief Function template specialization in namespace <code>std</code> to allow use of
+\link unity::storage::qt::Item Item\endlink instances with unordered containers.
+*/
 template<> struct Q_DECL_EXPORT hash<unity::storage::qt::Item>
 {
+    /**
+    \brief Returns a hash value.
+    \note The hash value is <i>not</i> necessarily the same as the one returned by
+    \link unity::storage::qt::qHash(const Item& i) qHash()\endlink (but <i>is</i> the same as the value returned
+    by \link unity::storage::qt::Item::hash() Item::hash()\endlink).
+    \return A hash value for use with unordered containers.
+    \see \link unity::storage::qt::Item::hash Item::hash()\endlink
+    */
     std::size_t operator()(unity::storage::qt::Item const& i) const
     {
         return i.hash();

=== modified file 'include/unity/storage/qt/ItemJob.h'
--- include/unity/storage/qt/ItemJob.h	2016-10-10 04:07:07 +0000
+++ include/unity/storage/qt/ItemJob.h	2017-04-21 01:35:48 +0000
@@ -38,34 +38,97 @@
 class Item;
 class StorageError;
 
+/**
+\brief Asynchronous job to retrieve an item.
+*/
+
 class Q_DECL_EXPORT ItemJob final : public QObject
 {
     Q_OBJECT
+
+    /**
+    \see \link isValid() const isValid()\endlink
+    */
     Q_PROPERTY(bool isValid READ isValid NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link status() const status()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::ItemJob::Status status READ status NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link error() const error()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::StorageError error READ error NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link item() const item()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::Item item READ item NOTIFY statusChanged FINAL)
 
 public:
+    /**
+    \brief Destroys the job.
+
+    It is safe to destroy a job while it is still executing.
+    */
     virtual ~ItemJob();
 
-    enum Status { Loading, Finished, Error };
+    /**
+    \brief Indicates the status of the job.
+    */
+    enum Status {
+        Loading,   /*!< The job is still executing. */
+        Finished,  /*!< The job finished succesfully. */
+        Error      /*!< The job finished with an error. */
+    };
     Q_ENUMS(Status)
 
+    /**
+    \brief Returns whether this job was successfully created.
+    \return If the job status is \link Error\endlink, the return value is <code>false</code>;
+    <code>true</code> otherwise.
+    */
     bool isValid() const;
+
+    /**
+    \brief Returns the current job status.
+    \return The job status.
+    */
     Status status() const;
+
+    /**
+    \brief Returns the last error that occured in this job.
+    \return A StorageError that indicates the cause of the error if isValid() returns <code>false</code>.
+    If isValid() returns <code>true</code>, the returned StorageError has type StorageError::NoError.
+    */
     StorageError error() const;
+
+    /**
+    \brief Returns the item for the job.
+    \return The item. If the status is not \link Finished\endlink, the returned Item is invalid.
+    */
     Item item() const;
 
 Q_SIGNALS:
+    /** @name Signals
+    */
+    //{@
+    /**
+    \brief This signal is emitted whenever this job transitions to the \link Finished\endlink or \link Error\endlink state.
+    \param status The status of the job.
+    */
     void statusChanged(unity::storage::qt::ItemJob::Status status) const;
+    //@}
 
 private:
+    ///@cond
     ItemJob(std::unique_ptr<internal::ItemJobImpl> p);
 
     std::unique_ptr<internal::ItemJobImpl> const p_;
 
     friend class internal::ItemJobImpl;
+    ///@endcond
 };
 
 }  // namespace qt

=== modified file 'include/unity/storage/qt/ItemListJob.h'
--- include/unity/storage/qt/ItemListJob.h	2016-10-10 04:07:07 +0000
+++ include/unity/storage/qt/ItemListJob.h	2017-04-21 01:35:48 +0000
@@ -44,28 +44,87 @@
 class Item;
 class StorageError;
 
+/**
+\brief Asynchronous job to retrieve an item.
+*/
 class Q_DECL_EXPORT ItemListJob final : public QObject
 {
     Q_OBJECT
+
+    /**
+    \see \link isValid() const isValid()\endlink
+    */
     Q_PROPERTY(bool isValid READ isValid NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link status() const status()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::ItemListJob::Status status READ status NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link error() const error()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::StorageError error READ error NOTIFY statusChanged FINAL)
 
 public:
+    /**
+    \brief Destroys the job.
+
+    It is safe to destroy a job while it is still executing.
+    */
     virtual ~ItemListJob();
 
-    enum Status { Loading, Finished, Error };
+    /**
+    \brief Indicates the status of the job.
+    */
+    enum Status {
+        Loading,   /*!< The job is still executing. */
+        Finished,  /*!< The job finished succesfully. */
+        Error      /*!< The job finished with an error. */
+    };
     Q_ENUMS(Status)
 
+    /**
+    \brief Returns whether this job was successfully created.
+    \return If the job status is \link Error\endlink, the return value is <code>false</code>;
+    <code>true</code> otherwise.
+    */
     bool isValid() const;
+
+    /**
+    \brief Returns the current job status.
+    \return The job status.
+    */
     Status status() const;
+
+    /**
+    \brief Returns the last error that occured in this job.
+    \return A StorageError that indicates the cause of the error if isValid() returns <code>false</code>.
+    If isValid() returns <code>true</code>, the returned StorageError has type StorageError::NoError.
+    */
     StorageError error() const;
 
 Q_SIGNALS:
+    /** @name Signals
+    */
+    //{@
+    /**
+    \brief This signal is emitted whenever this job transitions to the \link Finished\endlink or \link Error\endlink state.
+    \param status The status of the job.
+    */
     void statusChanged(unity::storage::qt::ItemListJob::Status status) const;
+
+    /**
+    \brief This signal is emitted whenever one or more items are available.
+
+    The provider may deliver items in batches. If so, this signal is emitted once for each batch.
+    \param items The available items.
+    */
     void itemsReady(QList<unity::storage::qt::Item> const& items) const;
+    //@}
 
 private:
+    ///@cond
     ItemListJob(std::unique_ptr<internal::ListJobImplBase> p);
 
     std::unique_ptr<internal::ListJobImplBase> const p_;
@@ -74,6 +133,7 @@
     friend class internal::ItemListJobImpl;
     friend class internal::MultiItemJobImpl;
     friend class internal::MultiItemListJobImpl;
+    ///@endcond
 };
 
 }  // namespace qt

=== modified file 'include/unity/storage/qt/Runtime.h'
--- include/unity/storage/qt/Runtime.h	2016-11-21 02:50:38 +0000
+++ include/unity/storage/qt/Runtime.h	2017-04-21 01:35:48 +0000
@@ -35,6 +35,9 @@
 {
 namespace storage
 {
+/**
+\brief This namespace contains the client-side API.
+*/
 namespace qt
 {
 namespace internal
@@ -46,24 +49,130 @@
 
 class AccountsJob;
 
+/**
+\brief Class to access to the storage framework runtime.
+
+Before you can do anything with the storage framework API, you must instantiate the Runtime.
+
+*/
 class Q_DECL_EXPORT Runtime : public QObject
 {
     Q_OBJECT
+
+    /**
+    \see \link isValid() const isValid()\endlink
+    */
     Q_PROPERTY(bool isValid READ isValid FINAL)
+
+    /**
+    \see \link error() const error()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::StorageError error READ error FINAL)
+
+    /**
+    \see \link connection() const connection()\endlink
+    */
     Q_PROPERTY(QDBusConnection connection READ connection CONSTANT FINAL)
 
 public:
+    /**
+    \brief Initializes the storage framework runtime.
+
+    You can interact with the storage framework API only while a Runtime instance exists.
+    You must create a Runtime instance before doing anything
+    else, and you must not interact with anything obtained via that runtime once it
+    is destroyed.
+    (Any calls to other instances obtained via this runtime after it has been destroyed
+    or after shutdown() was called fail with StorageError::RuntimeDestroyed.)
+
+    You can create more than one Runtime instance, but should generally not have any need to do so. (Each
+    instance uses a separate DBus connection to access providers.)
+    \param parent The runtime's owner object.
+    */
     Runtime(QObject* parent = nullptr);
+
+    /**
+    \brief Initializes the storage framework runtime for a specific DBus connection.
+
+    This constructor allows you to provide a separate DBus connection that the runtime will
+    use to access DBus services. This constructor is provided for testing the storage framework
+    API itself; you should not have any need to use it for a normal application.
+    \param bus The DBus connection to use for accessing DBus services.
+    \param parent The runtime's owner object.
+    */
     Runtime(QDBusConnection const& bus, QObject* parent = nullptr);
+
+    /**
+    \brief Destroys the storage framework runtime.
+
+    The destructor finalizes the runtime, that is, disconnects all signals and tears down the DBus connection.
+    Any calls to other instances obtained via this runtime after it has been destroyed
+    or after shutdown() was called fail with StorageError::RuntimeDestroyed.
+    */
     virtual ~Runtime();
 
+    /**
+    \brief Checks whether this runtime was successfully constructed.
+
+    If any errors were encountered during initialization, isValid() returns <code>false</code>
+    and youu can obtain further details about the cause of the error via the error() method.
+    \return Returns <code>true</code> if the runtime was successfully initialized; <code>false</code> otherwise.
+    */
     bool isValid() const;
+
+    /**
+    \brief Returns the last error that occured in this runtime.
+    \return A StorageError that indicates the cause of the error if isValid() returns <code>false</code>.
+    If isValid() returns <code>true</code>, the returned StorageError has type StorageError::NoError.
+    */
     StorageError error() const;
+
+    /**
+    \brief Returns the DBus connection used by this runtime.
+    \return The <a href="http://doc.qt.io/qt-5/qdbusconnection.html">QDBusConnection</a> used by this runtime
+    to access providers.
+    */
     QDBusConnection connection() const;
+
+    /**
+    \brief Shuts down the runtime.
+
+    This method is provided to allow you to check whether the runtime was successfully finalized and log
+    any errors. If errors were encountered during shutdown, isValid() returns <code>false</code>
+    and you can call error() to get the details of the problem.
+
+    Calling shutdown() more than once is safe and does nothing.
+
+    The destructor implicitly calls shutdown().
+
+    Any calls to other instances obtained via this runtime after
+    calling shutdown() fail with StorageError::RuntimeDestroyed.
+    \return Details of any error encountered during shutdown.
+    */
     StorageError shutdown();
+
+    /**
+    \brief Retrieves the list of available accounts.
+    \return An AccountsJob that, once complete, provides access to the available accounts.
+    \note You <i>must</i> deallocate the returned job by calling <code>delete</code>.
+    \see Account
+    */
     Q_INVOKABLE unity::storage::qt::AccountsJob* accounts() const;
 
+    /**
+    \brief Creates a test account.
+
+    This method is intended for testing. You can use the returned Account to talk to a provider that
+    listens on DBus with the provided bus name and object path.
+    (If you want to test a client application without the overhead of accessing a cloud provider or creating
+    a mock provider, we suggest to use the \link local-provider local provider\endlink.)
+    \param bus_name The DBus name of the provider for the account.
+    \param object_path The DBus object path of the provider for the account.
+    \param id The numeric ID of the account.
+    \param service_id The account service ID, such as "storage-provider-nextcloud".
+    \param name The name of the account, such as "[e-mail]".
+    \return The test account.
+    */
     Account make_test_account(QString const& bus_name,
                               QString const& object_path,
                               quint32 id = 999,

=== modified file 'include/unity/storage/qt/VoidJob.h'
--- include/unity/storage/qt/VoidJob.h	2016-10-10 04:07:07 +0000
+++ include/unity/storage/qt/VoidJob.h	2017-04-21 01:35:48 +0000
@@ -37,32 +37,86 @@
 
 class StorageError;
 
+/**
+\brief Asynchronous job to monitor progress of an operation that returns no result.
+*/
+
 class Q_DECL_EXPORT VoidJob final : public QObject
 {
     Q_OBJECT
+
+    /**
+    \see \link isValid() const isValid()\endlink
+    */
     Q_PROPERTY(bool isValid READ isValid NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link status() const status()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::VoidJob::Status status READ status NOTIFY statusChanged FINAL)
+
+    /**
+    \see \link error() const error()\endlink
+    */
     Q_PROPERTY(unity::storage::qt::StorageError error READ error NOTIFY statusChanged FINAL)
 
 public:
+    /**
+    \brief Destroys the job.
+
+    It is safe to destroy a job while it is still executing.
+    */
     virtual ~VoidJob();
 
-    enum Status { Loading, Finished, Error };
+    /**
+    \brief Indicates the status of the job.
+    */
+    enum Status {
+        Loading,   /*!< The job is still executing. */
+        Finished,  /*!< The job finished succesfully. */
+        Error      /*!< The job finished with an error. */
+    };
     Q_ENUMS(Status)
 
+    /**
+    \brief Returns whether this job was successfully created.
+    \return If the job status is \link Error\endlink, the return value is <code>false</code>;
+    <code>true</code> otherwise.
+    */
     bool isValid() const;
+
+    /**
+    \brief Returns the current job status.
+    \return The job status.
+    */
     Status status() const;
+
+    /**
+    \brief Returns the last error that occured in this job.
+    \return A StorageError that indicates the cause of the error if isValid() returns <code>false</code>.
+    If isValid() returns <code>true</code>, the returned StorageError has type StorageError::NoError.
+    */
     StorageError error() const;
 
 Q_SIGNALS:
+    /** @name Signals
+    */
+    //{@
+    /**
+    \brief This signal is emitted whenever this job transitions to the \link Finished\endlink or \link Error\endlink state.
+    \param status The status of the job.
+    */
     void statusChanged(unity::storage::qt::VoidJob::Status status) const;
+    //@}
 
 private:
+    ///@cond
     VoidJob(std::unique_ptr<internal::VoidJobImpl> p);
 
     std::unique_ptr<internal::VoidJobImpl> const p_;
 
     friend class internal::VoidJobImpl;
+    ///@endcond
 };
 
 }  // namespace qt

=== modified file 'plugins/Ubuntu/StorageFramework/plugin.cpp'
--- plugins/Ubuntu/StorageFramework/plugin.cpp	2016-11-02 02:54:48 +0000
+++ plugins/Ubuntu/StorageFramework/plugin.cpp	2017-04-21 01:35:48 +0000
@@ -20,9 +20,11 @@
 #include <unity/storage/qt/Runtime.h>
 #include <unity/storage/qt/Account.h>
 #include <unity/storage/qt/AccountsJob.h>
+#include <unity/storage/qt/Downloader.h>
 #include <unity/storage/qt/Item.h>
 #include <unity/storage/qt/ItemJob.h>
 #include <unity/storage/qt/ItemListJob.h>
+#include <unity/storage/qt/Uploader.h>
 
 using namespace unity::storage::qt;
 
@@ -41,6 +43,8 @@
     qmlRegisterUncreatableType<Item>(uri, 0, 1, "Item", "");
     qmlRegisterUncreatableType<ItemJob>(uri, 0, 1, "ItemJob", "Use Account or another item to access items");
     qmlRegisterUncreatableType<ItemListJob>(uri, 0, 1, "ItemListJob", "Use Account or another item to access items");
+    qmlRegisterUncreatableType<Downloader>(uri, 0, 1, "Downloader", "Use another item to create a downloader");
+    qmlRegisterUncreatableType<Uploader>(uri, 0, 1, "Uploader", "Use another item to create an uploader");
 }
 
 }

=== modified file 'tests/headers/CMakeLists.txt'
--- tests/headers/CMakeLists.txt	2016-11-18 05:55:17 +0000
+++ tests/headers/CMakeLists.txt	2017-04-21 01:35:48 +0000
@@ -16,7 +16,7 @@
 set(extra_inc_dirs "${Qt5Core_INCLUDE_DIRS}")
 set(extra_inc_dirs "${extra_inc_dirs};${Qt5DBus_INCLUDE_DIRS}")
 set(extra_inc_dirs "${extra_inc_dirs};${Qt5Network_INCLUDE_DIRS}")
-set(extra_inc_dirs "${extra_inc_dirs};${GIO_DEPS_INCLUDE_DIRS}")
+set(extra_inc_dirs "${extra_inc_dirs};${GLIB_DEPS_INCLUDE_DIRS}")
 set(extra_inc_dirs "${extra_inc_dirs};${ONLINEACCOUNTS_DEPS_INCLUDE_DIRS}")
 
 set(extra_defines "-D BOOST_THREAD_VERSION=4")

=== modified file 'tests/local-provider/CMakeLists.txt'
--- tests/local-provider/CMakeLists.txt	2017-03-10 04:46:55 +0000
+++ tests/local-provider/CMakeLists.txt	2017-04-21 01:35:48 +0000
@@ -9,7 +9,6 @@
     Qt5::Test
     ${Boost_LIBRARIES}
     ${GLIB_DEPS_LIBRARIES}
-    ${GIO_DEPS_LIBRARIES}
     testutils
     gtest
 )