docs: update bitmap doc

hiloteam · Apr 17, 2019 · 491c8d6 · 491c8d6
1 parent 3cd2dda
commit 491c8d6
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 14 deletions.
diff --git a/docs/api-en/code/view/Bitmap.js b/docs/api-en/code/view/Bitmap.js
@@ -49,7 +49,7 @@
      * set the image。
      * @param {Image|String} Image Object or URL.
      * @param {Array} rect the range of bitmap in the image, option.
-     * @param {Boolean} Whether cross-domain is needed, default is false.
+     * @param {Boolean} crossOrigin Whether cross-domain is needed, default is false.
      * @returns {Bitmap} self。
      */
     setImage: function(image, rect, crossOrigin){

diff --git a/docs/api-en/symbols/Bitmap.html b/docs/api-en/symbols/Bitmap.html
@@ -786,7 +786,7 @@ <h3 style="display:inline;margin-right:10px;">Methods</h3>
 
                     </td>
                     <td class="fixedFont">
-                        <div><b><a href="../symbols/Bitmap.html#setImage">setImage</a></b>(Image:Image|String, rect:Array, Whether:Boolean):Bitmap
+                        <div><b><a href="../symbols/Bitmap.html#setImage">setImage</a></b>(Image:Image|String, rect:Array, crossOrigin:Boolean):Bitmap
                         </div>
                         <div class="description">
 
@@ -1099,7 +1099,7 @@ <h3 style="margin-bottom:15px;">Constructor</h3>
         <div class="member-box">
         <div class="member-header">
 
-        <b>setImage</b>(Image:Image|String, rect:Array, Whether:Boolean):<span class="light"><a href="../symbols/Bitmap.html">Bitmap</a></span>
+        <b>setImage</b>(Image:Image|String, rect:Array, crossOrigin:Boolean):<span class="light"><a href="../symbols/Bitmap.html">Bitmap</a></span>
         </div>
         <div class="description">set the image。</div>
 
@@ -1120,8 +1120,8 @@ <h3 style="margin-bottom:15px;">Constructor</h3>
                 </dt>
 
                 <dt style="margin-left:20px;font-weight:normal;">
-                    <b>Whether</b>:<span>Boolean</span> 
-                     — cross-domain is needed, default is false.
+                    <b>crossOrigin</b>:<span>Boolean</span> 
+                     — Whether cross-domain is needed, default is false.
                 </dt>
 
             </dl>

diff --git a/docs/api-en/symbols/src/docs_api-en_code_view_Bitmap.js.html b/docs/api-en/symbols/src/docs_api-en_code_view_Bitmap.js.html
@@ -56,7 +56,7 @@
 <span class='line'> 49</span>      * set the image。
 <span class='line'> 50</span>      * @param {Image|String} Image Object or URL.
 <span class='line'> 51</span>      * @param {Array} rect the range of bitmap in the image, option.
-<span class='line'> 52</span>      * @param {Boolean} Whether cross-domain is needed, default is false.
+<span class='line'> 52</span>      * @param {Boolean} crossOrigin Whether cross-domain is needed, default is false.
 <span class='line'> 53</span>      * @returns {Bitmap} self。
 <span class='line'> 54</span>      */</span><span class="WHIT">
 <span class='line'> 55</span> </span><span class="WHIT">    </span><span class="NAME">setImage</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="PUNC">(</span><span class="NAME">image</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">rect</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">crossOrigin</span><span class="PUNC">)</span><span class="PUNC">{</span><span class="WHIT">

diff --git a/docs/api-zh/code/view/Bitmap.js b/docs/api-zh/code/view/Bitmap.js
@@ -49,7 +49,7 @@
      * 设置位图的图片。
      * @param {Image|String} image 图片对象或地址。
      * @param {Array} rect 指定位图在图片image的矩形区域。可选。
-     * @param {Boolean} 是否设置 crossOrigin，默认否。
+     * @param {Boolean} crossOrigin 是否设置 crossOrigin，默认否。
      * @returns {Bitmap} 位图本身。
      */
     setImage: function(image, rect, crossOrigin){

diff --git a/docs/api-zh/symbols/Bitmap.html b/docs/api-zh/symbols/Bitmap.html
@@ -787,7 +787,7 @@ <h3 style="display:inline;margin-right:10px;">方法概览</h3>
 
                     </td>
                     <td class="fixedFont">
-                        <div><b><a href="../symbols/Bitmap.html#setImage">setImage</a></b>(image:Image|String, rect:Array, 是否设置:Boolean):Bitmap
+                        <div><b><a href="../symbols/Bitmap.html#setImage">setImage</a></b>(image:Image|String, rect:Array, crossOrigin:Boolean):Bitmap
                         </div>
                         <div class="description">
 
@@ -1100,7 +1100,7 @@ <h3 style="margin-bottom:15px;">构造函数</h3>
         <div class="member-box">
         <div class="member-header">
 
-        <b>setImage</b>(image:Image|String, rect:Array, 是否设置:Boolean):<span class="light"><a href="../symbols/Bitmap.html">Bitmap</a></span>
+        <b>setImage</b>(image:Image|String, rect:Array, crossOrigin:Boolean):<span class="light"><a href="../symbols/Bitmap.html">Bitmap</a></span>
         </div>
         <div class="description">设置位图的图片。</div>
 
@@ -1121,8 +1121,8 @@ <h3 style="margin-bottom:15px;">构造函数</h3>
                 </dt>
 
                 <dt style="margin-left:20px;font-weight:normal;">
-                    <b>是否设置</b>:<span>Boolean</span> 
-                     — crossOrigin，默认否。
+                    <b>crossOrigin</b>:<span>Boolean</span> 
+                     — 是否设置 crossOrigin，默认否。
                 </dt>
 
             </dl>

diff --git a/docs/api-zh/symbols/src/docs_api-zh_code_view_Bitmap.js.html b/docs/api-zh/symbols/src/docs_api-zh_code_view_Bitmap.js.html
@@ -56,7 +56,7 @@
 <span class='line'> 49</span>      * 设置位图的图片。
 <span class='line'> 50</span>      * @param {Image|String} image 图片对象或地址。
 <span class='line'> 51</span>      * @param {Array} rect 指定位图在图片image的矩形区域。可选。
-<span class='line'> 52</span>      * @param {Boolean} 是否设置 crossOrigin，默认否。
+<span class='line'> 52</span>      * @param {Boolean} crossOrigin 是否设置 crossOrigin，默认否。
 <span class='line'> 53</span>      * @returns {Bitmap} 位图本身。
 <span class='line'> 54</span>      */</span><span class="WHIT">
 <span class='line'> 55</span> </span><span class="WHIT">    </span><span class="NAME">setImage</span><span class="PUNC">:</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="PUNC">(</span><span class="NAME">image</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">rect</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">crossOrigin</span><span class="PUNC">)</span><span class="PUNC">{</span><span class="WHIT">

diff --git a/src/view/Bitmap.js b/src/view/Bitmap.js
@@ -74,15 +74,15 @@
      * set the image。
      * @param {Image|String} Image Object or URL.
      * @param {Array} rect the range of bitmap in the image, option.
-     * @param {Boolean} Whether cross-domain is needed, default is false.
+     * @param {Boolean} crossOrigin Whether cross-domain is needed, default is false.
      * @returns {Bitmap} self。
      */
     /**
      * @language=zh
      * 设置位图的图片。
      * @param {Image|String} image 图片对象或地址。
      * @param {Array} rect 指定位图在图片image的矩形区域。可选。
-     * @param {Boolean} 是否设置 crossOrigin，默认否。
+     * @param {Boolean} crossOrigin 是否设置 crossOrigin，默认否。
      * @returns {Bitmap} 位图本身。
      */
     setImage: function(image, rect, crossOrigin){