Merge pull request #74 from NASA-AMMOS/issue-73

Issue #73 - Component docstring cleanup

ait/gui/static/js/ait/gui/Status.js

@@ -21,17 +21,15 @@
  * Allows for configuration of 4 state event handlers
  * ('on', 'off', 'pending', and 'error') via attributes on the ait-led tag.
  *
- * Example:
- *   <ait-led on="seq:exec" off="seq:done" error="seq:err"></ait-led>
- *  
- *  You can specify multiple triggers for a single state by separating the
- *  event names with a ','
+ * You can specify multiple triggers for a single state by separating the
+ * event names with a ','
  *
  * @example
  * <ait-led on="seq:exec,seq:sent" off="seq:done"></ait-led>
  *
  * @example
- * // If you want to start the LED in a state besides 'off' set it via the 'default' attribute
+ * // If you want to start the LED in a state besides 'off' set
+ * // it via the 'default' attribute
  * <ait-led on="seq:exec,seq:sent" default="pending"></ait-led>
  */
 const LED = {

ait/gui/static/js/ait/gui/TabSet.js

@@ -101,26 +101,26 @@ const DragDrop =
 /**
  * AIT TabSet
  *
- * AIT TabSet is a Mithril UI component for a `<ait-tabset>`,
- * which manages a set of children `<ait-tab>`s.  Tabs have a title
+ * AIT TabSet is a Mithril UI component for a **<ait-tabset>**,
+ * which manages a set of children **<ait-tab>**'s.  Tabs have a title
  * attribute and their own child content.  When a TabSet is rendered
- * to the DOM via its `view()` method, it:
+ * to the DOM via its **view()** method, it:
  *
- *     1.  Uses `<ait-tabset>` and `<ait-tab>` HTML5 custom tags
+ *     1.  Uses **<ait-tabset>** and **<ait-tab>** HTML5 custom tags
  *         for targeted CSS styling and customization, and
  *
  *     2.  Uses Bootstrap HTML structure and CSS classes
  *
  * A AIT TabSet is signficantly more succinct than Bootstrap tabs.
- * For example, compare creating a AIT TabSet directly in HTML:
+ * For example, compare creating a AIT TabSet directly in HTML::
  *
  *     <ait-tabset class="nav-tabs">
  *         <ait-tab title="Foo"> ... </ait-tab>
  *         <ait-tab title="Bar"> ... </ait-tab>
  *         <ait-tab title="Baz"> ... </ait-tab>
  *     </ait-tab>
  *
- * To the corresponding Bootstrap HTML and CSS:
+ * To the corresponding Bootstrap HTML and CSS::
  *
  *     <ul class="nav nav-tabs">
  *         <li> <a href="#">Foo</a> </li>
@@ -134,11 +134,11 @@ const DragDrop =
  *     <!-- Repeat for the contents of all three tabs -->
  *
  * Tabs may also be rendered as Bootstrap pills, stacked, justified,
- * etc. by adding the [appropriate CSS
- * classes](http://getbootstrap.com/components/#nav) to a
+ * etc. by adding the `appropriate CSS
+ * classes <http://getbootstrap.com/components/#nav>`_ to a
  * <ait-tabset>.
  *
- * Tabs may be reordered programmatically via `TabSet.move(from, to)`
+ * Tabs may be reordered programmatically via **TabSet.move(from, to)**
  * or by interactively via drag-and-drop.
  */
 const TabSet =