Merge pull request #18 from rctoris/master

ros2djs and nav2djs r1 doc added
RobotWebTools · Apr 16, 2013 · 8f6b5bb · 8f6b5bb
2 parents e651976 + 50c4765
commit 8f6b5bb
Show file tree

Hide file tree

Showing 60 changed files with 8,724 additions and 0 deletions.
diff --git a/jsdoc/nav2djs/current/NAV2D.Navigator.html b/jsdoc/nav2djs/current/NAV2D.Navigator.html
@@ -0,0 +1,306 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Navigator</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Class: Navigator</h1>
+
+
+
+
+
+<section>
+
+<header>
+    <h2>
+        <span class="ancestors"><a href="global.html#NAV2D">NAV2D</a>.</span>
+
+    Navigator
+    </h2>
+
+</header>  
+
+<article>
+    <div class="container-overview">
+
+
+
+
+<dt>
+    <h4 class="name" id="Navigator"><span class="type-signature"></span>new Navigator<span class="signature">(options)</span><span class="type-signature"></span></h4>
+
+
+</dt>
+<dd>
+
+
+    <div class="description">
+        A navigator can be used to add click-to-navigate options to an object.
+    </div>
+
+
+
+
+
+
+
+        <h5>Parameters:</h5>
+
+
+<table class="params">
+    <thead>
+	<tr>
+
+		<th>Name</th>
+
+
+		<th>Type</th>
+
+
+
+
+
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+
+	<tbody>
+
+
+        <tr>
+
+                <td class="name"><code>options</code></td>
+
+
+            <td class="type">
+
+            </td>
+
+
+
+
+
+            <td class="description last">object with following keys:
+  * ros - the ROSLIB.Ros connection handle
+  * serverName (optional) - the action server name to use for navigation, like '/move_base'
+  * actionName (optional) - the navigation action name, like 'move_base_msgs/MoveBaseAction'
+  * rootObject (optional) - the root object to add the click listeners to and render robot markers to</td>
+        </tr>
+
+
+	</tbody>
+</table>
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Navigator.js.html">navigator/Navigator.js</a>, line 15
+    </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+</dd>
+
+
+    </div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        <h3 class="subsection-title">Methods</h3>
+
+        <dl>
+
+<dt>
+    <h4 class="name" id="sendGoal"><span class="type-signature">&lt;inner> </span>sendGoal<span class="signature">(pose)</span><span class="type-signature"></span></h4>
+
+
+</dt>
+<dd>
+
+
+    <div class="description">
+        Send a goal to the navigation stack with the given pose.
+    </div>
+
+
+
+
+
+
+
+        <h5>Parameters:</h5>
+
+
+<table class="params">
+    <thead>
+	<tr>
+
+		<th>Name</th>
+
+
+		<th>Type</th>
+
+
+
+
+
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+
+	<tbody>
+
+
+        <tr>
+
+                <td class="name"><code>pose</code></td>
+
+
+            <td class="type">
+
+            </td>
+
+
+
+
+
+            <td class="description last">the goal pose</td>
+        </tr>
+
+
+	</tbody>
+</table>
+
+
+
+<dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Navigator.js.html">navigator/Navigator.js</a>, line 35
+    </li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+</dd>
+
+        </dl>
+
+
+
+
+
+</article>
+
+</section>  
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="NAV2D.Navigator.html">Navigator</a></li><li><a href="NAV2D.OccupancyGridClientNav.html">OccupancyGridClientNav</a></li></ul><h3>Global</h3><ul><li><a href="global.html#NAV2D">NAV2D</a></li></ul>
+</nav>
+
+<br clear="both">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Mon Apr 15 2013 14:29:21 GMT-0700 (PDT)
+</footer>
+
+<script> prettyPrint(); </script>
+</body>
+</html>