Verison 0.6.198, add jsdoc commnets.

[pettanr/clientJs.git] / 0.6.x / js / 05_util / 04_XXML.js

diff --git a/0.6.x/js/05_util/04_XXML.js b/0.6.x/js/05_util/04_XXML.js
index df77214..5cc2c64 100644 (file)
--- a/0.6.x/js/05_util/04_XXML.js
+++ b/0.6.x/js/05_util/04_XXML.js
@@ -9,7 +9,6 @@
  * \r
  * TODO X.Class で作り、kill を強要する\r
  */\r
-\r
 X[ 'XML' ] = XMLWrapper;\r
 \r
 /**\r
@@ -17,12 +16,17 @@ X[ 'XML' ] = XMLWrapper;
  * @alias X.XML\r
  * @class XML 探索用のラッパークラスです\r
  * @constructor\r
- * @param {xml}\r
+ * @param {XMLElement}\r
  */\r
 function XMLWrapper( xml ){\r
        this._rawXML = xml;\r
 };\r
 \r
+/**\r
+ * ラップした xml の数 常に1または0, XMLList の場合2以上\r
+ * @alias X.XML.prototype.length\r
+ * @type {Number}\r
+ */\r
 XMLWrapper.prototype.length      = 1;\r
 XMLWrapper.prototype[ 'parent' ] = XMLWrapper_parent;\r
 XMLWrapper.prototype[ 'has' ]    = XMLWrapper_has;\r
@@ -30,6 +34,11 @@ XMLWrapper.prototype[ 'get' ]    = XMLWrapper_get;
 XMLWrapper.prototype[ 'val' ]    = XMLWrapper_val;\r
 XMLWrapper.prototype[ 'find' ]   = XMLWrapper_find;\r
 \r
+/**\r
+ * 親要素を返す、ルート要素の場合 null を返す\r
+ * @alias X.XML.prototype.parent\r
+ * @return {X.XML} 親要素\r
+ */\r
 function XMLWrapper_parent(){\r
        if( this.length === 1 ) return this._rawXML && this._rawXML.parentNode ? new XMLWrapper( this._rawXML.parentNode ) : null;\r
        if( this.length === 0 ) return null;\r
@@ -37,10 +46,23 @@ function XMLWrapper_parent(){
        return this[ 0 ].parentNode ? ( new XMLWrapper( this[ 0 ].parentNode ) ) : null;\r
 };\r
 \r
+/**\r
+ * セレクターにヒットした要素数を返す\r
+ * @alias X.XML.prototype.has\r
+ * @param {string} queryString XML セレクター文字列\r
+ * @return {number}\r
+ */\r
 function XMLWrapper_has( queryString ){\r
        return !!this.find( queryString ).length;\r
 };\r
 \r
+/**\r
+ * <p>X.XML では常に自信を返す\r
+ * <p>X.XMLList ではラップした xml 群から index のものを返す\r
+ * @alias X.XML.prototype.get\r
+ * @param {number} index\r
+ * @return {X.XML} X.XML では自身、X.XMLList では index の X.XML\r
+ */\r
 function XMLWrapper_get( index ){\r
        if( this.length === 1 ) return this;\r
        if( this.length === 0 ) return null;\r
@@ -52,6 +74,13 @@ function XMLWrapper_get( index ){
                null;\r
 };\r
 \r
+/**\r
+ * セレクターにヒットした要素の内容を指定されたデータ型で返す。複数要素にヒットした場合、0番目の要素の内容を使用する。\r
+ * @alias X.XML.prototype.val\r
+ * @param {string} queryString XML セレクター文字列\r
+ * @param {string} type 'number','int','boolean','string'\r
+ * @return {boolean|number|string} 内容を型変換した値\r
+ */\r
 function XMLWrapper_val( queryString, type ){\r
        var //attr_textContent = X_UA[ 'IE' ] < 9 || X_UA[ 'Opera' ] ? 'innerText' : X_UA[ 'IE9' ] ? 'text' : 'textContent',\r
                wrapper, xml, v;\r
@@ -98,6 +127,12 @@ function XMLWrapper_val( queryString, type ){
        return v || '';\r
 };\r
 \r
+/**\r
+ * セレクターにヒットした要素を返す。0～1個の要素がヒットした場合は X.XML を、それ以上の場合は X.XMLList を返す。\r
+ * @alias X.XML.prototype.find\r
+ * @param {string} queryString セレクター文字列\r
+ * @return {X.XML|X.XMLList} \r
+ */\r
        function XMLWrapper_find( queryString ){\r
 \r
                var scope     = this.constructor === XMLListWrapper ? this : [ this._rawXML ],\r
@@ -576,6 +611,13 @@ var XMLWrapper_filter = {
        }\r
 };\r
 \r
+/**\r
+ * XML配列を扱う XML 探索用のラッパークラスです\r
+ * @alias X.XMLList\r
+ * @class XMLList XML配列を扱う XML 探索用のラッパークラスです\r
+ * @constructor\r
+ * @extends {X.XML}\r
+ */\r
 function XMLListWrapper( xmlList ){\r
        var i = 0, l = xmlList ? xmlList.length : 0;\r
        for( ; i < l; ++i ){\r