Some PDoc corrections.

madrobby · Nov 14, 2009 · 26ce305 · 26ce305
1 parent 6041127
commit 26ce305
Show file tree

Hide file tree

Showing 16 changed files with 26 additions and 24 deletions.
diff --git a/src/ui/behaviors.js b/src/ui/behaviors.js
@@ -1,4 +1,4 @@
-/** section: scripty2 UI
+/** section: scripty2 ui
  *  class S2.UI.Behavior
  *  
  *  Abstract base class for assigning sets of events.

diff --git a/src/ui/behaviors/down.js b/src/ui/behaviors/down.js
@@ -1,4 +1,4 @@
-/** section: scripty2 UI
+/** section: scripty2 ui
  *  class S2.UI.Behavior.Down < UI.Behavior
  *  
  *  Applies a down-state behavior. Adds a `ui-state-down` class to any 

diff --git a/src/ui/behaviors/drag.js b/src/ui/behaviors/drag.js
@@ -1,4 +1,4 @@
-/** section: scripty2 UI
+/** section: scripty2 ui
  *  class S2.UI.Behavior.Drag < S2.UI.Behavior
  *  
  *  Applies a drag behavior. Takes a `handle` option that points to the drag

diff --git a/src/ui/behaviors/focus.js b/src/ui/behaviors/focus.js
@@ -1,5 +1,5 @@
-/** section: scripty2 UI
- *  class UI.Behavior.Focus < S2.UI.Behavior
+/** section: scripty2 ui
+ *  class S2.UI.Behavior.Focus < S2.UI.Behavior
  *  
  *  Applies a focus behavior. Adds a `ui-state-focus` class to any
  *  non-disabled element when focused.

diff --git a/src/ui/behaviors/hover.js b/src/ui/behaviors/hover.js
@@ -1,4 +1,4 @@
-/** section: scripty2 UI
+/** section: scripty2 ui
  *  class S2.UI.Behavior.Hover < S2.UI.Behavior
  *  
  *  Applies a hover behavior. Adds a `ui-state-hover` class to any 

diff --git a/src/ui/behaviors/resize.js b/src/ui/behaviors/resize.js
@@ -1,4 +1,4 @@
-/** section: scripty2 UI
+/** section: scripty2 ui
  *  class S2.UI.Behavior.Resize < S2.UI.Behavior
 **/
 S2.UI.Behavior.Resize = Class.create(S2.UI.Behavior, {

diff --git a/src/ui/controls/accordion.js b/src/ui/controls/accordion.js
@@ -4,7 +4,7 @@ Object.extend(Event, {
 
 (function(UI) {
 
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.Accordion
    *  includes S2.UI.Mixin.Configurable
   **/

diff --git a/src/ui/controls/autocompleter.js b/src/ui/controls/autocompleter.js
@@ -2,9 +2,9 @@
 
 (function(UI) {
 
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.Autocompleter
-   *  includes UI.Mixin.Configurable
+   *  includes S2.UI.Mixin.Configurable
   **/
   UI.Autocompleter = Class.create(UI.Mixin.Configurable, {
     /**

diff --git a/src/ui/controls/button.js b/src/ui/controls/button.js
@@ -1,6 +1,6 @@
 
 (function(UI) {  
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.Button
    *  includes S2.UI.Mixin.Configurable
    *  

diff --git a/src/ui/controls/dialog.js b/src/ui/controls/dialog.js
@@ -1,6 +1,6 @@
 (function(UI) {
 
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.Dialog
    *  includes S2.UI.Mixin.Configurable
    *  

diff --git a/src/ui/controls/menu.js b/src/ui/controls/menu.js
@@ -1,12 +1,12 @@
 
 (function(UI) {
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.Menu
-   *  includes UI.Mixin.Configurable
+   *  includes S2.UI.Mixin.Configurable
   **/
   UI.Menu = Class.create(UI.Mixin.Configurable, {
     /**
-     *  new S2.UI.Menu([element], [options])
+     *  new S2.UI.Menu([element][, options])
     **/
     initialize: function(element, options) {
       this.element = $(element);

diff --git a/src/ui/controls/overlay.js b/src/ui/controls/overlay.js
@@ -1,6 +1,6 @@
 (function(UI) {
 
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.Overlay
    *  includes S2.UI.Mixin.Configurable, S2.UI.Mixin.Trackable
    *  

diff --git a/src/ui/controls/progress_bar.js b/src/ui/controls/progress_bar.js
@@ -1,5 +1,5 @@
 (function(UI) {
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.ProgressBar
    *  includes S2.UI.Mixin.Configurable
    *  

diff --git a/src/ui/controls/slider.js b/src/ui/controls/slider.js
@@ -1,7 +1,7 @@
 
 
 (function(UI) {
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.Slider
    *  includes S2.UI.Mixin.Configurable
    *  
@@ -229,7 +229,7 @@
     },
 
     /**
-     *  S2.UI.Slider#setValue(sliderValue[, handleIndex]);
+     *  S2.UI.Slider#setValue(sliderValue[, handleIndex]) -> this
      *  - sliderValue (Number): The new value for the slider handle.
      *  - handleIndex (Number): The index of the handle to move (for use on
      *    sliders with more than one handle). If omitted, the first/only handle
@@ -279,6 +279,8 @@
         });
         this.options.onSlide(this.values, this);
       }
+
+      return this;
     },
 
     _getNearestValue: function(value) {

diff --git a/src/ui/controls/tabs.js b/src/ui/controls/tabs.js
@@ -1,6 +1,6 @@
 
 (function(UI) {  
-  /** section: scripty2 UI
+  /** section: scripty2 ui
    *  class S2.UI.Tabs
    *  includes S2.UI.Mixin.Configurable
    *  

diff --git a/src/ui/mixin.js b/src/ui/mixin.js
@@ -17,12 +17,12 @@ Object.deepExtend = function(destination, source) {
   return destination;
 };
 
-/** section: scripty2 UI
- *  S2.UI.Mixin
+/** section: scripty2 ui
+ * S2.UI.Mixin
 **/
 S2.UI.Mixin = {};
 
-/** section: scripty2 UI
+/** section: scripty2 ui
  *  mixin S2.UI.Mixin.Configurable
  *  
  *  A mixin for hassle-free blending of default options with user-defined
@@ -60,7 +60,7 @@ S2.UI.Mixin.Configurable = {
   }
 };
 
-/** section: scripty2 UI
+/** section: scripty2 ui
  *  mixin S2.UI.Mixin.Trackable
 **/
 S2.UI.Mixin.Trackable = {