summaryrefslogtreecommitdiffstats
path: root/browser/components/backup/docs
diff options
context:
space:
mode:
Diffstat (limited to 'browser/components/backup/docs')
-rw-r--r--browser/components/backup/docs/backup-service.rst8
-rw-r--r--browser/components/backup/docs/index.rst13
2 files changed, 21 insertions, 0 deletions
diff --git a/browser/components/backup/docs/backup-service.rst b/browser/components/backup/docs/backup-service.rst
new file mode 100644
index 0000000000..fe363b46b4
--- /dev/null
+++ b/browser/components/backup/docs/backup-service.rst
@@ -0,0 +1,8 @@
+========================
+Backup Service Reference
+========================
+
+.. js::autoattribute:: BackupService#instance
+.. js:autoclass:: BackupService
+ :members:
+ :private-members:
diff --git a/browser/components/backup/docs/index.rst b/browser/components/backup/docs/index.rst
new file mode 100644
index 0000000000..1e201f8f1c
--- /dev/null
+++ b/browser/components/backup/docs/index.rst
@@ -0,0 +1,13 @@
+.. _components/backup:
+
+================
+Backup Component
+================
+
+The Backup Component is responsible for creating backups of user profile data
+into a single file that can be easily restored from.
+
+.. toctree::
+ :maxdepth: 3
+
+ backup-service