Chun-Ping Chang avatar Chun-Ping Chang committed 2600ddf

MODIFY: js binding api desc improve

Comments (0)

Files changed (2)

 
       <div class="hero-unit" id="lib">
         <h2>Libraries</h2>
+        <em>You can get those language binding on <a href="https://github.com/GaiaSup/api" target="_blank">Github</a></em>
         <hr/>
         <ol>
           <li>
 
       <div class="hero-unit">
         <h2>gaia.Node.revokeNode(:onDone)</h2>
-        <em>Register a new Layer.</em>
+        <em>Revoke the current Node.</em>
         <div>
           <br/>
           <strong>Example: </strong>
       </div>
       <div class="hero-unit">
         <h2>gaia.Node.join(:layer, :id)</h2>
-        <em>Join the system directly with a Node.</em>
+        <em>Join the system directly with a Node. perform registerLayer and registerNode together.</em>
         <div>
           <br/>
           <strong>Example: </strong>
 
       <div class="hero-unit">
         <h2>gaia.Node.subscribeNearby(:radius, :onUpdate, :interval)</h2>
-        <em>Subscribe the updates of Nodes within a radius.</em>
+        <em>Subscribe the updates of Nodes within a radius. this method performs querySqaure periodically as specified by 'interval'.</em>
         <div>
           <br/>
           <strong>Example: </strong>
 
       <div class="hero-unit">
         <h2>gaia.Node.getNeighbors()</h2>
-        <em>Get a list of neighbor Nodes currently known.</em>
+        <em>Get a list of neighbor Nodes currently known (i.e., Nodes that are learned by calling querySquare).</em>
         <div>
           <br/>
           <strong>Example: </strong>
 
       <div class="hero-unit">
         <h2>gaia.Node.isJoined()</h2>
-        <em>Check if the current Node has joined successfully.</em>
+        <em>Check if the current Node has joined successfully (i.e., has performed registerLayer and registerNode successfully).</em>
         <div>
           <br/>
           <strong>Example: </strong>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.