Upgrade to ExtJS 4.0.7 - Released 10/19/2011

[extjs.git] / docs / source / Point.html
diff --git a/docs/source/Point.html b/docs/source/Point.html

index 8723e9d..e13a3e4 100644 (file)
--- a/docs/source/Point.html
+++ b/docs/source/Point.html
@@ -3,8 +3,8 @@
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>The source code</title>
-  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
    <style type="text/css">
      .highlight { display: block; background-color: #ddd; }
    </style>
@@ -16,16 +16,12 @@
  </head>
  <body onload="prettyPrint(); highlight();">
    <pre class="prettyprint lang-js"><span id='Ext-util-Point'>/**
-</span> * @class Ext.util.Point
- * @extends Ext.util.Region
- *
- * Represents a 2D point with x and y properties, useful for comparison and instantiation
+</span> * Represents a 2D point with x and y properties, useful for comparison and instantiation
   * from an event:
- * &lt;pre&gt;&lt;code&gt;
- * var point = Ext.util.Point.fromEvent(e);
- * &lt;/code&gt;&lt;/pre&gt;
+ *
+ *     var point = Ext.util.Point.fromEvent(e);
+ *
   */
-
  Ext.define('Ext.util.Point', {
  
      /* Begin Definitions */
@@ -33,11 +29,11 @@ Ext.define('Ext.util.Point', {
  
      statics: {
  
-<span id='Ext-util-Point-method-fromEvent'>        /**
+<span id='Ext-util-Point-static-method-fromEvent'>        /**
  </span>         * Returns a new instance of Ext.util.Point base on the pageX / pageY values of the given event
           * @static
           * @param {Event} e The event
-         * @returns Ext.util.Point
+         * @return {Ext.util.Point}
           */
          fromEvent: function(e) {
              e = (e.changedTouches &amp;&amp; e.changedTouches.length &gt; 0) ? e.changedTouches[0] : e;
@@ -47,6 +43,11 @@ Ext.define('Ext.util.Point', {
  
      /* End Definitions */
  
+<span id='Ext-util-Point-method-constructor'>    /**
+</span>     * Creates a point from two coordinates.
+     * @param {Number} x X coordinate.
+     * @param {Number} y Y coordinate.
+     */
      constructor: function(x, y) {
          this.callParent([y, x, y, x]);
      },
@@ -72,8 +73,7 @@ Ext.define('Ext.util.Point', {
  
  <span id='Ext-util-Point-method-isWithin'>    /**
  </span>     * Whether the given point is not away from this point within the given threshold amount.
-     * TODO: Rename this isNear.
-     * @param {Ext.util.Point/Object} The point to check with, either an instance
+     * @param {Ext.util.Point/Object} p The point to check with, either an instance
       * of Ext.util.Point or an object with left and top properties
       * @param {Object/Number} threshold Can be either an object with x and y properties or a number
       * @return {Boolean}
@@ -93,7 +93,7 @@ Ext.define('Ext.util.Point', {
  <span id='Ext-util-Point-method-roundedEquals'>    /**
  </span>     * Compare this point with another point when the x and y values of both points are rounded. E.g:
       * [100.3,199.8] will equals to [100, 200]
-     * @param {Ext.util.Point/Object} The point to compare with, either an instance
+     * @param {Ext.util.Point/Object} p The point to compare with, either an instance
       * of Ext.util.Point or an object with x and y properties
       * @return {Boolean}
       */
@@ -102,12 +102,9 @@ Ext.define('Ext.util.Point', {
      }
  }, function() {
  <span id='Ext-util-Point-method-translate'>    /**
-</span>     * Translate this region by the given offset amount. TODO: Either use translate or translateBy!
-     * @param {Ext.util.Offset/Object} offset Object containing the &lt;code&gt;x&lt;/code&gt; and &lt;code&gt;y&lt;/code&gt; properties.
-     * Or the x value is using the two argument form.
-     * @param {Number} The y value unless using an Offset object.
-     * @return {Ext.util.Region} this This Region
-     * @method
+</span>     * @method
+     * Alias for {@link #translateBy}
+     * @alias Ext.util.Region#translateBy
       */
      this.prototype.translate = Ext.util.Region.prototype.translateBy;
  });