summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs
diff options
context:
space:
mode:
Diffstat (limited to 'chrome/common/extensions/docs')
-rw-r--r--chrome/common/extensions/docs/server2/api_data_source.py1
-rw-r--r--chrome/common/extensions/docs/server2/app.yaml2
-rw-r--r--chrome/common/extensions/docs/server2/cron.yaml8
-rw-r--r--chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json1
-rw-r--r--chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json1
-rw-r--r--chrome/common/extensions/docs/server2/test_data/test_json/test_file.json1
-rw-r--r--chrome/common/extensions/docs/templates/intros/dial.html30
7 files changed, 39 insertions, 5 deletions
diff --git a/chrome/common/extensions/docs/server2/api_data_source.py b/chrome/common/extensions/docs/server2/api_data_source.py
index 7f3d32c..3fdd375 100644
--- a/chrome/common/extensions/docs/server2/api_data_source.py
+++ b/chrome/common/extensions/docs/server2/api_data_source.py
@@ -132,6 +132,7 @@ class _JSCModel(object):
return {}
return {
'name': self._namespace.name,
+ 'description': self._namespace.description,
'types': self._GenerateTypes(self._namespace.types.values()),
'functions': self._GenerateFunctions(self._namespace.functions),
'events': self._GenerateEvents(self._namespace.events),
diff --git a/chrome/common/extensions/docs/server2/app.yaml b/chrome/common/extensions/docs/server2/app.yaml
index f8c706ba7..537333d 100644
--- a/chrome/common/extensions/docs/server2/app.yaml
+++ b/chrome/common/extensions/docs/server2/app.yaml
@@ -1,5 +1,5 @@
application: chrome-apps-doc
-version: 2-7-2
+version: 2-8-0
runtime: python27
api_version: 1
threadsafe: false
diff --git a/chrome/common/extensions/docs/server2/cron.yaml b/chrome/common/extensions/docs/server2/cron.yaml
index 9529324..f67361a 100644
--- a/chrome/common/extensions/docs/server2/cron.yaml
+++ b/chrome/common/extensions/docs/server2/cron.yaml
@@ -2,19 +2,19 @@ cron:
- description: Load everything for trunk.
url: /_cron/trunk
schedule: every 5 minutes
- target: 2-7-2
+ target: 2-8-0
- description: Load everything for dev.
url: /_cron/dev
schedule: every 5 minutes
- target: 2-7-2
+ target: 2-8-0
- description: Load everything for beta.
url: /_cron/beta
schedule: every 5 minutes
- target: 2-7-2
+ target: 2-8-0
- description: Load everything for stable.
url: /_cron/stable
schedule: every 5 minutes
- target: 2-7-2
+ target: 2-8-0
diff --git a/chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json b/chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json
index b9dfa6b..9d5993a 100644
--- a/chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json
+++ b/chrome/common/extensions/docs/server2/test_data/test_json/expected_test_file.json
@@ -94,6 +94,7 @@
],
"properties": [],
"name": "tester",
+ "description": "a test api",
"types": [
{
"properties": [
diff --git a/chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json b/chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json
index 6e07fe1..d9fffae 100644
--- a/chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json
+++ b/chrome/common/extensions/docs/server2/test_data/test_json/ref_test.json
@@ -1,6 +1,7 @@
[
{
"namespace": "ref_test",
+ "description": "An API for testing ref's",
"types": [
{
"id": "type1",
diff --git a/chrome/common/extensions/docs/server2/test_data/test_json/test_file.json b/chrome/common/extensions/docs/server2/test_data/test_json/test_file.json
index ea39b62..5f4fbf5 100644
--- a/chrome/common/extensions/docs/server2/test_data/test_json/test_file.json
+++ b/chrome/common/extensions/docs/server2/test_data/test_json/test_file.json
@@ -1,6 +1,7 @@
[
{
"namespace": "tester",
+ "description": "a test api",
"types": [
{
"id": "TypeA",
diff --git a/chrome/common/extensions/docs/templates/intros/dial.html b/chrome/common/extensions/docs/templates/intros/dial.html
new file mode 100644
index 0000000..9d84882
--- /dev/null
+++ b/chrome/common/extensions/docs/templates/intros/dial.html
@@ -0,0 +1,30 @@
+<p>The <code>chrome.dial</code> API is backed by a service that multicasts
+discovery requests on the local network to discover DIAL-capable devices and
+maintains a list of devices that have responded. Adding an onDeviceList
+listener causes the service to periodically issue discovery requests to maintain
+the device list. (No polling is done when there are no onDeviceList listeners.)
+</p>
+
+<p>The onDeviceList event is fired when discovery respnses are received and in
+other circumstances; see the documentation for onDeviceList.</p>
+
+<p>The client can request that network discovery can be done immediately by
+invoking discoverNow() which is useful for presenting the user with an
+updated list of devices.</p>
+
+<p>On-demand use (updates when discoverNow() is called):
+<pre>
+chrome.dial.onDeviceList.addListener(function (list) { updateMenu(list); });
+chrome.dial.discoverNow();
+</pre>
+(Remember to remove the listener when the menu closes.)</p>
+
+<p>Background use (updates only when periodic polling happens):</p>
+
+<pre>
+var myList;
+chrome.dial.onDeviceList.addListener(function (list) { myList = list; });
+</pre>
+
+<p>These can be combined to poll for devices to prime the device menu, then
+refresh the menu when it is displayed.</p>