From 64dd8d41f08eae8dd4f793348e498c8ef3dc75b0 Mon Sep 17 00:00:00 2001 From: drebs Date: Thu, 2 Nov 2017 12:30:56 -0200 Subject: [doc] add blobs api doc --- docs/api/blobs/blobmanager.rst | 15 +++++++++++++++ docs/api/blobs/errors.rst | 6 ++++++ docs/api/blobs/sync.rst | 12 ++++++++++++ 3 files changed, 33 insertions(+) create mode 100644 docs/api/blobs/blobmanager.rst create mode 100644 docs/api/blobs/errors.rst create mode 100644 docs/api/blobs/sync.rst (limited to 'docs/api/blobs') diff --git a/docs/api/blobs/blobmanager.rst b/docs/api/blobs/blobmanager.rst new file mode 100644 index 00000000..04165a57 --- /dev/null +++ b/docs/api/blobs/blobmanager.rst @@ -0,0 +1,15 @@ +.. _blobmanager-api: + +Blobs creation, retrieval, deletion and flagging +================================================ + +The ``BlobManager`` class is responsible for blobs creation, retrieval, +deletion, flagging and synchronizing. For better code organization, the methods +related to synchronization are implemented separatelly in a superclass (see +:ref:`blobs-sync-api`). + +.. autoclass:: leap.soledad.client._db.blobs.BlobManager + :members: + :special-members: __init__ + :undoc-members: + :show-inheritance: diff --git a/docs/api/blobs/errors.rst b/docs/api/blobs/errors.rst new file mode 100644 index 00000000..66454631 --- /dev/null +++ b/docs/api/blobs/errors.rst @@ -0,0 +1,6 @@ +Blobs Errors +============ + +.. automodule:: leap.soledad.client._db.blobs.errors + :members: + :undoc-members: diff --git a/docs/api/blobs/sync.rst b/docs/api/blobs/sync.rst new file mode 100644 index 00000000..53740d64 --- /dev/null +++ b/docs/api/blobs/sync.rst @@ -0,0 +1,12 @@ +.. _blobs-sync-api: + +Blobs Synchronization +===================== + +The synchronization part of the ``BlobManager`` class is implemented in the +``BlobsSynchronizer`` class, whose API can be seen below. + +.. autoclass:: leap.soledad.client._db.blobs.sync.BlobsSynchronizer + :members: + :special-members: __init__ + :undoc-members: -- cgit v1.2.3