summaryrefslogtreecommitdiffstats
path: root/browser/components/uitour/docs
diff options
context:
space:
mode:
Diffstat (limited to 'browser/components/uitour/docs')
-rw-r--r--browser/components/uitour/docs/UITour-lib.rst11
-rw-r--r--browser/components/uitour/docs/index.rst8
2 files changed, 19 insertions, 0 deletions
diff --git a/browser/components/uitour/docs/UITour-lib.rst b/browser/components/uitour/docs/UITour-lib.rst
new file mode 100644
index 0000000000..7f12956808
--- /dev/null
+++ b/browser/components/uitour/docs/UITour-lib.rst
@@ -0,0 +1,11 @@
+UITour library API
+==================
+
+This is the web API provided by the library UITour-lib.js for use by web content with appropriate permissions.
+
+.. js:autoclass:: Mozilla.UITour
+ :members:
+ :exclude-members: Configuration
+
+.. js:autoclass:: Mozilla.UITour.Configuration
+ :members:
diff --git a/browser/components/uitour/docs/index.rst b/browser/components/uitour/docs/index.rst
new file mode 100644
index 0000000000..95e1fcec1a
--- /dev/null
+++ b/browser/components/uitour/docs/index.rst
@@ -0,0 +1,8 @@
+UITour
+======
+
+.. toctree::
+ UITour-lib
+
+.. js:autoclass:: Mozilla.UITour
+ :members: none