doc: Merge/update old Elements.Methods docs for class name stuff into…

… source. [prototypejs#81 state:fixed_in_branch]
samleb · Jan 12, 2010 · 02d94a2 · 02d94a2
1 parent ed5f144
commit 02d94a2
Showing 1 changed file with 36 additions and 3 deletions.
diff --git a/src/dom/dom.js b/src/dom/dom.js
@@ -1468,7 +1468,17 @@ Element.Methods = {
   /**
    *  Element.hasClassName(@element, className) -> Boolean
    *
-   *  Checks whether `element` has the given CSS class name.
+   *  Checks for the presence of CSS class `className` on `element`.
+   *
+   *  ##### Examples
+   *  
+   *      <div id="mutsu" class="apple fruit food"></div>
+   *  
+   *      $('mutsu').hasClassName('fruit');
+   *      // -> true
+   *      
+   *      $('mutsu').hasClassName('vegetable');
+   *      // -> false
   **/
   hasClassName: function(element, className) {
     if (!(element = $(element))) return;
@@ -1508,7 +1518,17 @@ Element.Methods = {
   /**
    *  Element.removeClassName(@element, className) -> Element
    *
-   *  Removes a CSS class from `element`.
+   *  Removes CSS class `className` from `element`.
+   *
+   *  ##### Examples
+   *  
+   *      <div id="mutsu" class="apple fruit food"></div>
+   *  
+   *      $('mutsu').removeClassName('food');
+   *      // -> Element
+   *      
+   *      $('mutsu').classNames;
+   *      // -> 'apple fruit'
   **/
   removeClassName: function(element, className) {
     if (!(element = $(element))) return;
@@ -1520,7 +1540,20 @@ Element.Methods = {
   /**
    *  Element.toggleClassName(@element, className) -> Element
    *
-   *  Toggles the presence of a CSS class on `element`.
+   *  Toggles the presence of CSS class `className` on `element`.
+   *
+   *  ##### Examples
+   *  
+   *      <div id="mutsu" class="apple"></div>
+   *  
+   *      $('mutsu').hasClassName('fruit');
+   *      // -> false
+   *      
+   *      $('mutsu').toggleClassName('fruit');
+   *      // -> element
+   *      
+   *      $('mutsu').hasClassName('fruit');
+   *      // -> true
   **/
   toggleClassName: function(element, className) {
     if (!(element = $(element))) return;