Michelle Bu 11 years ago
parent
commit
835cb2c2d8
3 changed files with 16 additions and 10 deletions
  1. 5 5
      docs/api.json
  2. 0 0
      docs/index.html
  3. 11 5
      docs/style.css

+ 5 - 5
docs/api.json

@@ -9,7 +9,7 @@
         "name": "id",
         "optional": true,
         "type": "string",
-        "description": "Other peers can connect to this peer using the provided ID. If no ID is given, one will be generated by the brokering server.<span class='tip'>It's not recommended that you use this ID to identify peers, as it's meant to be used for brokering connections only. You're recommended to set the <a href='#peerconnect-options'><code>metadata</code></a> option to send other identifying information.</span>"
+        "description": "Other peers can connect to this peer using the provided ID. If no ID is given, one will be generated by the brokering server.<span class='warn'>It's not recommended that you use this ID to identify peers, as it's meant to be used for brokering connections only. You're recommended to set the <a href='#peerconnect-options'><code>metadata</code></a> option to send other identifying information.</span>"
       },
       {
         "name": "options",
@@ -240,14 +240,14 @@
     "name": "peer.disconnect",
     "type": "method",
     "snippet": "peer.disconnect();",
-    "description": "Close the connection to the server, leaving all existing data and media connections intact. <a href='#peerdisconnected'><code>peer.disconnected</code></a> will be set to <code>true</code>.<span class='tip'>This cannot be undone; the respective peer object will no longer be able to create or receive any connections and its ID will be forfeited on the (cloud) server.</span>"
+    "description": "Close the connection to the server, leaving all existing data and media connections intact. <a href='#peerdisconnected'><code>peer.disconnected</code></a> will be set to <code>true</code>.<span class='warn'>This cannot be undone; the respective peer object will no longer be able to create or receive any connections and its ID will be forfeited on the (cloud) server.</span>"
   },
 
   {
     "name": "peer.destroy",
     "type": "method",
     "snippet": "peer.destroy();",
-    "description": "Close the connection to the server and terminate all existing connections. <a href='#peerdestroyed'><code>peer.destroyed</code></a> will be set to <code>true</code>.<span class='tip'>This cannot be undone; the respective peer object will no longer be able to create or receive any connections, its ID will be forfeited on the (cloud) server, and all of its data and media connections will be closed.</span>"
+    "description": "Close the connection to the server and terminate all existing connections. <a href='#peerdestroyed'><code>peer.destroyed</code></a> will be set to <code>true</code>.<span class='warn'>This cannot be undone; the respective peer object will no longer be able to create or receive any connections, its ID will be forfeited on the (cloud) server, and all of its data and media connections will be closed.</span>"
   },
 
   {
@@ -428,7 +428,7 @@
     "name": "util",
     "type": "object",
     "tags": ["utility"],
-    "description": "Provides a variety of helpful utilities.<span class='tip'>Only the utilities documented here are guaranteed to be present on <code>util</code>. Undocumented utilities can be removed without warning. We don't consider these to be 'breaking changes.'</span>",
+    "description": "Provides a variety of helpful utilities.<span class='warn'>Only the utilities documented here are guaranteed to be present on <code>util</code>. Undocumented utilities can be removed without warning. We don't consider these to be 'breaking changes.'</span>",
     "children": [
       {
         "name": ".browser",
@@ -440,7 +440,7 @@
         "name": ".supports",
         "type": "object",
         "snippet": "if (util.supports.data) { /* OK to start a data connection. */ }",
-        "description": "A hash of WebRTC features mapped to booleans that correspond to whether the feature is supported by the current browser.<span class='tip'>Only the properties documented here are guaranteed to be present on <code>util.supports</code>.</span>",
+        "description": "A hash of WebRTC features mapped to booleans that correspond to whether the feature is supported by the current browser.<span class='warn'>Only the properties documented here are guaranteed to be present on <code>util.supports</code>.</span>",
         "children": [
           {
             "name": ".audioVideo",

File diff suppressed because it is too large
+ 0 - 0
docs/index.html


+ 11 - 5
docs/style.css

@@ -168,19 +168,25 @@ body, html {
 }
 /* /name */
 
-.tip {
-  opacity: 0.7;
+.tip, .warn {
+  opacity: 0.9;
   display: block;
   background-color: #d1c7be;
   font-size: 13px;
   line-height: 18px;
-  font-weight: 600;
   border-radius: 2px;
   padding: 5px 8px;
-  color: #544e4a;
   border: 2px solid rgba(0,0,0,0.2);
+  margin: 8px 8px 0 0;
+}
+
+.warn {
+  background-color: #8F4537;
+}
+.tip {
+  color: #544e4a;
   text-shadow: 0px -1px 0px rgba(255,255,255,0.2);
-  margin: 8px 0 0 0;
+  font-weight: 600;
 }
 
 #peer-options-debug .child {

Some files were not shown because too many files changed in this diff