Changeset 11218

Timestamp:

10/30/07 03:51:05 (10 months ago)

Author:

alex

Message:

updating inline docs such that they get picked up by the parser. Refs #4820

Files:

• dojo/trunk/_base/html.js (modified) (8 diffs)

dojo/trunk/_base/html.js

@@ -14 +14 @@
 // =============================
 
+/*=====
+dojo.byId = function(id, doc){
+        //      summary:
+        //              similar to other library's "$" function, takes a
+        //              string representing a DOM id or a DomNode and
+        //              returns the corresponding DomNode. If a Node is
+        //              passed, this function is a no-op. Returns a
+        //              single DOM node or null, working around several
+        //              browser-specific bugs to do so.
+        //      id: String|DomNode
+        //              DOM id or DOM Node
+        //      doc: DocumentElement?
+        //              optional, defaults to the current value of
+        //              dojo.doc.  Can be used to retreive
+        //              node references from other documents.
+        //      return:
+        //              DomNode
+}
+=====*/
+
 if(dojo.isIE || dojo.isOpera){
-        dojo.byId = function(/*String*/id, /*DocumentElement*/doc){
-                // summary:
-                //              similar to other library's "$" function, takes a
-                //              string representing a DOM id or a DomNode and
-                //              returns the corresponding DomNode. If a Node is
-                //              passed, this function is a no-op. Returns a
-                //              single DOM node or null, working around several
-                //              browser-specific bugs to do so.
-                // id: DOM id or DOM Node
-                // doc:
-                //              optional, defaults to the current value of
-                //              dojo.doc.  Can be used to retreive
-                //              node references from other documents.
+        dojo.byId = function(id, doc){
                 if(dojo.isString(id)){
                         var _d = doc || dojo.doc;
@@ -50 +58 @@
         }
 }else{
-        dojo.byId = function(/*String*/id, /*DocumentElement*/doc){
-                // summary:
-                //              similar to other library's "$" function, takes a
-                //              string representing a DOM id or a DomNode and
-                //              returns the corresponding DomNode. If a Node is
-                //              passed, this function is a no-op. Returns a
-                //              single DOM node or null, working around several
-                //              browser-specific bugs to do so.
-                // id: DOM id or DOM Node
-                // doc:
-                //              optional, defaults to the current value of
-                //              dojo.doc.  Can be used to retreive
-                //              node references from other documents.
+        dojo.byId = function(id, doc){
                 if(dojo.isString(id)){
                         return (doc || dojo.doc).getElementById(id);
@@ -99 +95 @@
         };
 
-        dojo.isDescendant = function(/*Node|String*/node, /*Node|String*/ancestor){
+        dojo.isDescendant = function(/*DomNode|String*/node, /*DomNode|String*/ancestor){
                 //      summary:
                 //              Returns true if node is a descendant of ancestor
@@ -117 +113 @@
         };
 
-        dojo.setSelectable = function(/*Node|String*/node, /*Boolean*/selectable){
-                // summary: enable or disable selection on a node
+        dojo.setSelectable = function(/*DomNode|String*/node, /*Boolean*/selectable){
+                //      summary: enable or disable selection on a node
+                //      node:
+                //              id or reference to node
+                //      selectable:
                 node = dojo.byId(node);
                 if(dojo.isMozilla){
@@ -247 +246 @@
         dojo.getComputedStyle = function(node){ //DomNode
                 //      summary:
-                //              returns a "computed style" object which can be used to
-                //              gather information about the current state of the
-                //              rendered node. 
-                //              Note that this may behave differently on different 
-                //              browsers. Values may have different formats and value 
-                //              encodings across browsers. 
+                //              returns a "computed style" object.
+                //      description:
+                //              get "computed style" object which can be used to gather
+                //              information about the current state of the rendered node. 
+                //
+                //              Note that this may behave differently on different browsers.
+                //              Values may have different formats and value encodings across
+                //              browsers. 
+                //
                 //              Use the dojo.style() method for more consistent (pixelized)
                 //              return values.
@@ -321 +323 @@
 
         // FIXME: there opacity quirks on FF that we haven't ported over. Hrm.
-
-        dojo._getOpacity = (dojo.isIE ? function(/*DomNode*/node){
+        /*=====
+        dojo._getOpacity = function(node){
                         //      summary:
                         //              returns the current opacity of the passed node as a
                         //              floating-point value between 0 and 1.
-                        //      node:
+                        //      node: DomNode
                         //              a reference to a DOM node. Does NOT support taking an
                         //              ID string for speed reasons.
+                        //      return: Number between 0 and 1
+        }
+        =====*/
+
+        dojo._getOpacity = (dojo.isIE ? function(node){
                         try{
                                 return (node.filters.alpha.opacity / 100); // Number
@@ -339 +346 @@
         );
 
-        dojo._setOpacity = (dojo.isIE ? function(/*DomNode*/node, /*Number*/opacity){
+        /*=====
+        dojo._setOpacity = function(node, opacity){
                         //      summary:
                         //              set the opacity of the passed node portably. Returns the
@@ -348 +356 @@
                         //      opacity:
                         //              Number between 0 and 1. 0 specifies transparent.
+                        //      return: Number between 0 and 1
+        }
+        =====*/
+
+        dojo._setOpacity = (dojo.isIE ? function(/*DomNode*/node, /*Number*/opacity){
                         if(opacity == 1){
                                 // on IE7 Alpha(Filter opacity=100) makes text look fuzzy so remove it altogether (bug #2661)