doc improvements

stensrud · Aug 13, 2014 · f1444be · f1444be
1 parent 0305fe6
commit f1444be
Show file tree

Hide file tree

Showing 22 changed files with 374 additions and 63 deletions.
diff --git a/doc/GpxExtent.html b/doc/GpxExtent.html
@@ -260,7 +260,7 @@ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-g
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Jun 20 2014 09:52:36 GMT+0100 (BST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/GpxMetaData.html b/doc/GpxMetaData.html
@@ -30,6 +30,8 @@ <h2>
     GpxMetaData
     </h2>
 
+        <div class="class-description">Stores all the metadata associated with the gpx file.</div>
+
 </header>  
 
 <article>
@@ -39,7 +41,7 @@ <h2>
 
 
 <dt>
-    <h4 class="name" id="GpxMetaData"><span class="type-signature"></span>new GpxMetaData<span class="signature">(creator)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="GpxMetaData"><span class="type-signature"></span>new GpxMetaData<span class="signature">(creator, time)</span><span class="type-signature"></span></h4>
 
 
 </dt>
@@ -97,7 +99,30 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">The creator of the gpx file</td>
+            <td class="description last">The creator of the gpx file.</td>
+        </tr>
+
+
+
+        <tr>
+
+                <td class="name"><code>time</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">string</span>
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last">The string representation of the datetime from the file.</td>
         </tr>
 
 
@@ -128,7 +153,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="gpxMetaData.js.html">gpxMetaData.js</a>, <a href="gpxMetaData.js.html#line6">line 6</a>
+        <a href="gpxMetaData.js.html">gpxMetaData.js</a>, <a href="gpxMetaData.js.html#line8">line 8</a>
     </li></ul></dd>
 
 
@@ -189,7 +214,7 @@ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-g
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Jun 20 2014 09:52:36 GMT+0100 (BST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/GpxResult.html b/doc/GpxResult.html
@@ -41,7 +41,7 @@ <h2>
 
 
 <dt>
-    <h4 class="name" id="GpxResult"><span class="type-signature"></span>new GpxResult<span class="signature">(creator)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="GpxResult"><span class="type-signature"></span>new GpxResult<span class="signature">(metadata, waypoints, routes, tracks)</span><span class="type-signature"></span></h4>
 
 
 </dt>
@@ -83,13 +83,13 @@ <h5>Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>creator</code></td>
+                <td class="name"><code>metadata</code></td>
 
 
             <td class="type">
 
 
-<span class="param-type">string</span>
+<span class="param-type"><a href="GpxMetaData.html">GpxMetaData</a></span>
 
 
 
@@ -99,7 +99,76 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last">The creator of the gpx</td>
+            <td class="description last">The metadata associated with the gpx trace</td>
+        </tr>
+
+
+
+        <tr>
+
+                <td class="name"><code>waypoints</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">Array.&lt;<a href="GpxWaypoint.html">GpxWaypoint</a>></span>
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last">An array of waypoints.</td>
+        </tr>
+
+
+
+        <tr>
+
+                <td class="name"><code>routes</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">Array.&lt;<a href="GpxRoute.html">GpxRoute</a>></span>
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last">An array of routes.</td>
+        </tr>
+
+
+
+        <tr>
+
+                <td class="name"><code>tracks</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">Array.&lt;<a href="GpxTrack.html">GpxTrack</a>></span>
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last">An array of tracks.</td>
         </tr>
 
 
@@ -130,7 +199,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="gpxResult.js.html">gpxResult.js</a>, <a href="gpxResult.js.html#line7">line 7</a>
+        <a href="gpxResult.js.html">gpxResult.js</a>, <a href="gpxResult.js.html#line10">line 10</a>
     </li></ul></dd>
 
 
@@ -191,7 +260,7 @@ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-g
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Jun 20 2014 09:52:36 GMT+0100 (BST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/GpxRoute.html b/doc/GpxRoute.html
@@ -260,7 +260,7 @@ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-g
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Jun 20 2014 09:52:36 GMT+0100 (BST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/GpxTrack.html b/doc/GpxTrack.html
@@ -41,7 +41,7 @@ <h2>
 
 
 <dt>
-    <h4 class="name" id="GpxTrack"><span class="type-signature"></span>new GpxTrack<span class="signature">(segments)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="GpxTrack"><span class="type-signature"></span>new GpxTrack<span class="signature">(segments, name)</span><span class="type-signature"></span></h4>
 
 
 </dt>
@@ -103,6 +103,29 @@ <h5>Parameters:</h5>
         </tr>
 
 
+
+        <tr>
+
+                <td class="name"><code>name</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">String</span>
+
+
+
+            </td>
+
+
+
+
+
+            <td class="description last">The name of the Track</td>
+        </tr>
+
+
 	</tbody>
 </table>
 
@@ -130,7 +153,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="gpxTrack.js.html">gpxTrack.js</a>, <a href="gpxTrack.js.html#line9">line 9</a>
+        <a href="gpxTrack.js.html">gpxTrack.js</a>, <a href="gpxTrack.js.html#line10">line 10</a>
     </li></ul></dd>
 
 
@@ -217,7 +240,7 @@ <h4 class="name" id="length"><span class="type-signature"></span>length<span cla
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="gpxTrack.js.html">gpxTrack.js</a>, <a href="gpxTrack.js.html#line33">line 33</a>
+        <a href="gpxTrack.js.html">gpxTrack.js</a>, <a href="gpxTrack.js.html#line34">line 34</a>
     </li></ul></dd>
 
 
@@ -286,7 +309,7 @@ <h4 class="name" id="segment"><span class="type-signature"></span>segment<span c
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="gpxTrack.js.html">gpxTrack.js</a>, <a href="gpxTrack.js.html#line26">line 26</a>
+        <a href="gpxTrack.js.html">gpxTrack.js</a>, <a href="gpxTrack.js.html#line27">line 27</a>
     </li></ul></dd>
 
 
@@ -333,7 +356,7 @@ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-g
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Jun 20 2014 09:52:36 GMT+0100 (BST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/GpxWaypoint.html b/doc/GpxWaypoint.html
@@ -919,7 +919,7 @@ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-g
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Jun 20 2014 09:52:36 GMT+0100 (BST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/geomUtils.js.html b/doc/geomUtils.js.html
@@ -95,7 +95,7 @@ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-g
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Jun 20 2014 09:52:36 GMT+0100 (BST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/doc/global.html b/doc/global.html
@@ -93,15 +93,15 @@ <h3 class="subsection-title">Type Definitions</h3>
         <dl>
 
 <dt>
-    <h4 class="name" id="requestCallback"><span class="type-signature"></span>requestCallback<span class="signature">(error, responseMessage)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="gpxParseCompleteCallback"><span class="type-signature"></span>gpxParseCompleteCallback<span class="signature">(error, response)</span><span class="type-signature"></span></h4>
 
 
 </dt>
 <dd>
 
 
     <div class="description">
-        /* Callback document for gpxParseCompleteCallback
+        Callback when gpx result has been processed.
     </div>
 
 
@@ -158,13 +158,13 @@ <h5>Parameters:</h5>
 
         <tr>
 
-                <td class="name"><code>responseMessage</code></td>
+                <td class="name"><code>response</code></td>
 
 
             <td class="type">
 
 
-<span class="param-type">string</span>
+<span class="param-type"><a href="GpxResult.html">GpxResult</a></span>
 
 
 
@@ -174,7 +174,7 @@ <h5>Parameters:</h5>
 
 
 
-            <td class="description last"></td>
+            <td class="description last">The parsed gpx file object</td>
         </tr>
 
 
@@ -205,7 +205,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="gpx-parse.js.html">gpx-parse.js</a>, <a href="gpx-parse.js.html#line188">line 188</a>
+        <a href="gpx-parse.js.html">gpx-parse.js</a>, <a href="gpx-parse.js.html#line223">line 223</a>
     </li></ul></dd>
 
 
@@ -250,7 +250,7 @@ <h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-g
 <br clear="both">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Fri Jun 20 2014 09:52:36 GMT+0100 (BST)
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Wed Aug 13 2014 09:19:33 GMT+0100 (BST)
 </footer>
 
 <script> prettyPrint(); </script>