updating docs

Author: lauren mccarthy

docs/css/main.css

@@ -10,6 +10,15 @@
    Base styles: opinionated defaults
    ========================================================================== */
 
+td {
+    vertical-align: top;
+    font-size: 1.2em;
+    padding-bottom: 0.75em;
+}
+
+td:first-child {
+    padding-right: 0.5em;
+}
 
 /* 
   //////////////////////////////////////////////////
@@ -257,7 +266,7 @@ section#reference h2 {
 }
 
 #reference .core, #reference .addon {
-    color: #222;
+    color: #704F21;
 }
 
 html,

docs/yuidoc-p5-theme-src/scripts/main.js

@@ -17,6 +17,9 @@ require([
   'underscore',
   'backbone',
   'App'], function(_, Backbone, App) {
+
+    
+require(['router']);
 
   // Set collections
   App.collections = ['allItems', 'classes', 'events', 'methods', 'properties', 'p5.sound', 'p5.dom'];
@@ -62,6 +65,7 @@ require([
     // Get class items (methods, properties, events)
     _.each(items, function(el, idx, array) {
 
+      el.hash = App.router.getHash(el);
       if (el.itemtype) {
         if (el.itemtype === "method") {
           App.methods.push(el);
@@ -93,6 +97,5 @@ require([
 
 
 
-    require(['router']);
   });
 });

docs/yuidoc-p5-theme-src/scripts/tpl/class.html

@@ -21,9 +21,12 @@ <h4>Fields</h4>
 <% if (methods.length > 0) { %>
   <h4>Methods</h4>
   <p>
+    <table>
     <% _.each(methods, function(item) { %>
-      <a href="<%=item.hash%>" <% if (item.module !== module) { %>class="addon"<% } %>><%=item.name%><% if (item.itemtype === 'method') { %>()<%}%></a>: <%= item.description %>
-      <br>
+      <tr>
+      <td><a href="<%=item.hash%>" <% if (item.module !== module) { %>class="addon"<% } %>><%=item.name%><% if (item.itemtype === 'method') { %>()<%}%></a></td><td><%= item.description %></td>
+      </tr>
     <% }); %>
+    </table>
   </p>
 <% } %>

docs/yuidoc-p5-theme-src/scripts/tpl/item.html

@@ -93,32 +93,35 @@ <h4>Syntax</h4>
 <% if (item.params) { %>
 <div class="params">
   <h4>Parameters</h4>
-  <ul>
+  <table>
   <% for (var i=0; i<item.params.length; i++) { %>
-    <li>
+    <tr>
+    <td>
     <% var p = item.params[i] %>
     <% if (p.optional) { %>
       <code class="language-javascript">[<%=p.name%>]</code>
     <% } else { %>
       <code class="language-javascript"><%=p.name%></code>
     <% } %> 
     <%if (p.optdefault) { %>=<%=p.optdefault%><% } %>
+    </td>
+    <td>
     <% if (p.type) { %>
       <span class="param-type label label-info"><%=p.type%></span>: <%=p.description%></span> 
     <% } %>
     <% if (p.multiple) {%>
       <span class="flag multiple" title="This argument may occur one or more times.">multiple</span>
     <% } %>
-    </li>
+    </td>
+    </tr>
   <% } %>
-  </ul>
+  </table>
 </div>
 <% } %>
 
 <% if (item.return) { %>
 <div>
   <h4>Returns</h4>
-
     <% if (item.return.type) { %>
       <p><span class="param-type label label-info"><%=item.return.type%></span>: <%= item.return.description %></p>
     <% } %>

lib/addons/p5.dom.js

@@ -1,4 +1,4 @@
-/*! p5.dom.js v0.0.1 July 31, 2014 */
+/*! p5.dom.js v0.1.0 August 6, 2014 */
 /**
  * <p>The web is much more than just canvas and p5.dom makes it easy to interact 
  * with other HTML5 objects, including text, hyperlink, image, input, video, 
@@ -600,7 +600,10 @@ var p5DOM = (function(){
 
 
   /**
-   * A class to describe...
+   * Extends p5.Element to handle audio and video. In addition to the methods
+   * of p5.Element, it also contains methods for controlling media. It is not
+   * called directly, but p5.MediaElements are created by calling createVideo,
+   * createAudio, and createCapture.
    *
    * @class p5.MediaElement
    * @constructor

src/objects/p5.Element.js

@@ -8,7 +8,12 @@ define(function(require) {
   var p5 = require('core');
 
   /**
-   * A class to describe...
+   * Base class for all elements added to a sketch, including canvas,
+   * graphics buffers, and other HTML elements. Methods in blue are
+   * included in the core functionality, methods in black are added
+   * with the p5.dom library. It is not called directly, but p5.Element
+   * objects are created by calling createCanvas, createGraphics,
+   * or in the p5.dom library, createDiv, createImg, createInput, etc.
    *
    * @class p5.Element
    * @constructor

src/objects/p5.Graphics.js

@@ -1,7 +1,7 @@
 /**
  * @module Rendering
  * @submodule Rendering
- * @for p5.Graphics
+ * @for p5
  */
 define(function(require) {