Merge pull request #1780 from AnalyticalGraphicsInc/refdoc

Clean up memberof in reference doc

Author: shunter

Source/Core/ArcGisImageServerTerrainProvider.js

@@ -157,8 +157,6 @@ define([
      * {@link ArcGisImageServerTerrainProvider#ready} returns true.  The result includes terrain
      * data and indicates that all child tiles are available.
      *
-     * @memberof ArcGisImageServerTerrainProvider
-     *
      * @param {Number} x The X coordinate of the tile for which to request geometry.
      * @param {Number} y The Y coordinate of the tile for which to request geometry.
      * @param {Number} level The level of the tile for which to request geometry.
@@ -213,8 +211,6 @@ define([
     /**
      * Gets the maximum geometric error allowed in a tile at a given level.
      *
-     * @memberof ArcGisImageServerTerrainProvider
-     *
      * @param {Number} level The tile level for which to get the maximum geometric error.
      * @returns {Number} The maximum geometric error.
      */
@@ -227,8 +223,6 @@ define([
      * indicates which areas of the globe are water rather than land, so they can be rendered
      * as a reflective surface with animated waves.
      *
-     * @memberof ArcGisImageServerTerrainProvider
-     *
      * @returns {Boolean} True if the provider has a water mask; otherwise, false.
      */
     ArcGisImageServerTerrainProvider.prototype.hasWaterMask = function() {

Source/Core/AssociativeArray.js

@@ -50,7 +50,6 @@ define([
     /**
      * Associates the provided key with the provided value.  If the key already
      * exists, it is overwritten with the new value.
-     * @memberof AssociativeArray
      *
      * @param {String|Number} key A unique identifier.
      * @param {Object} value The value to associate with the provided key.
@@ -69,7 +68,6 @@ define([
 
     /**
      * Retrieves the value associated with the provided key.
-     * @memberof AssociativeArray
      *
      * @param {String|Number} key The key whose value is to be retrieved.
      * @returns {Object} The associated value, or undefined if the key does not exist in the collection.
@@ -85,7 +83,6 @@ define([
 
     /**
      * Removes a key-value pair from the collection.
-     * @memberof AssociativeArray
      *
      * @param {String|Number} key The key to be removed.
      * @returns {Boolean} True if it was removed, false if the key was not in the collection.
@@ -109,7 +106,6 @@ define([
 
     /**
      * Clears the collection.
-     * @memberof AssociativeArray
      */
     AssociativeArray.prototype.removeAll = function() {
         this._hash = {};

Source/Core/AxisAlignedBoundingBox.js

@@ -57,7 +57,6 @@ define([
     /**
      * Computes an instance of an AxisAlignedBoundingBox. The box is determined by
      * finding the points spaced the farthest apart on the x, y, and z axes.
-     * @memberof AxisAlignedBoundingBox
      *
      * @param {Cartesian3[]} positions List of points that the bounding box will enclose.  Each point must have a <code>x</code>, <code>y</code>, and <code>z</code> properties.
      * @param {AxisAlignedBoundingBox} [result] The object onto which to store the result.
@@ -120,7 +119,6 @@ define([
 
     /**
      * Duplicates a AxisAlignedBoundingBox instance.
-     * @memberof AxisAlignedBoundingBox
      *
      * @param {AxisAlignedBoundingBox} box The bounding box to duplicate.
      * @param {AxisAlignedBoundingBox} [result] The object onto which to store the result.
@@ -144,7 +142,6 @@ define([
     /**
      * Compares the provided AxisAlignedBoundingBox componentwise and returns
      * <code>true</code> if they are equal, <code>false</code> otherwise.
-     * @memberof AxisAlignedBoundingBox
      *
      * @param {AxisAlignedBoundingBox} [left] The first AxisAlignedBoundingBox.
      * @param {AxisAlignedBoundingBox} [right] The second AxisAlignedBoundingBox.
@@ -162,7 +159,6 @@ define([
     var intersectScratch = new Cartesian3();
     /**
      * Determines which side of a plane a box is located.
-     * @memberof AxisAlignedBoundingBox
      *
      * @param {AxisAlignedBoundingBox} box The bounding box to test.
      * @param {Cartesian4} plane The coefficients of the plane in the form <code>ax + by + cz + d = 0</code>
@@ -202,7 +198,6 @@ define([
 
     /**
      * Duplicates this AxisAlignedBoundingBox instance.
-     * @memberof AxisAlignedBoundingBox
      *
      * @param {AxisAlignedBoundingBox} [result] The object onto which to store the result.
      * @returns {AxisAlignedBoundingBox} The modified result parameter or a new AxisAlignedBoundingBox instance if one was not provided.
@@ -213,7 +208,6 @@ define([
 
     /**
      * Determines which side of a plane this box is located.
-     * @memberof AxisAlignedBoundingBox
      *
      * @param {Cartesian4} plane The coefficients of the plane in the form <code>ax + by + cz + d = 0</code>
      *                           where the coefficients a, b, c, and d are the components x, y, z, and w
@@ -230,7 +224,6 @@ define([
     /**
      * Compares this AxisAlignedBoundingBox against the provided AxisAlignedBoundingBox componentwise and returns
      * <code>true</code> if they are equal, <code>false</code> otherwise.
-     * @memberof AxisAlignedBoundingBox
      *
      * @param {AxisAlignedBoundingBox} [right] The right hand side AxisAlignedBoundingBox.
      * @returns {Boolean} <code>true</code> if they are equal, <code>false</code> otherwise.

Source/Core/BoundingRectangle.js

@@ -64,7 +64,6 @@ define([
     /**
      * Computes a bounding rectangle enclosing the list of 2D points.
      * The rectangle is oriented with the corner at the bottom left.
-     * @memberof BoundingRectangle
      *
      * @param {Cartesian2[]} positions List of points that the bounding rectangle will enclose.  Each point must have <code>x</code> and <code>y</code> properties.
      * @param {BoundingRectangle} [result] The object onto which to store the result.
@@ -114,7 +113,6 @@ define([
     var fromRectangleUpperRight = new Cartographic();
     /**
      * Computes a bounding rectangle from an rectangle.
-     * @memberof BoundingRectangle
      *
      * @param {Rectangle} rectangle The valid rectangle used to create a bounding rectangle.
      * @param {Object} [projection=GeographicProjection] The projection used to project the rectangle into 2D.
@@ -150,7 +148,6 @@ define([
 
     /**
      * Duplicates a BoundingRectangle instance.
-     * @memberof BoundingRectangle
      *
      * @param {BoundingRectangle} rectangle The bounding rectangle to duplicate.
      * @param {BoundingRectangle} [result] The object onto which to store the result.
@@ -174,7 +171,6 @@ define([
 
     /**
      * Computes a bounding rectangle that is the union of the left and right bounding rectangles.
-     * @memberof BoundingRectangle
      *
      * @param {BoundingRectangle} left A rectangle to enclose in bounding rectangle.
      * @param {BoundingRectangle} right A rectangle to enclose in a bounding rectangle.
@@ -209,7 +205,6 @@ define([
 
     /**
      * Computes a bounding rectangle by enlarging the provided rectangle until it contains the provided point.
-     * @memberof BoundingRectangle
      *
      * @param {BoundingRectangle} rectangle A rectangle to expand.
      * @param {Cartesian2} point A point to enclose in a bounding rectangle.
@@ -250,7 +245,6 @@ define([
 
     /**
      * Determines if two rectangles intersect.
-     * @memberof BoundingRectangle
      *
      * @param {BoundingRectangle} left A rectangle to check for intersection.
      * @param {BoundingRectangle} right The other rectangle to check for intersection.
@@ -283,7 +277,6 @@ define([
     /**
      * Compares the provided BoundingRectangles componentwise and returns
      * <code>true</code> if they are equal, <code>false</code> otherwise.
-     * @memberof BoundingRectangle
      *
      * @param {BoundingRectangle} [left] The first BoundingRectangle.
      * @param {BoundingRectangle} [right] The second BoundingRectangle.
@@ -301,7 +294,6 @@ define([
 
     /**
      * Duplicates this BoundingRectangle instance.
-     * @memberof BoundingRectangle
      *
      * @param {BoundingRectangle} [result] The object onto which to store the result.
      * @returns {BoundingRectangle} The modified result parameter or a new BoundingRectangle instance if one was not provided.
@@ -312,7 +304,6 @@ define([
 
     /**
      * Determines if this rectangle intersects with another.
-     * @memberof BoundingRectangle
      *
      * @param {BoundingRectangle} right A rectangle to check for intersection.
      * @returns {Intersect} <code>Intersect.INTESECTING</code> if the rectangles intersect, <code>Intersect.OUTSIDE</code> otherwise.
@@ -324,7 +315,6 @@ define([
     /**
      * Compares this BoundingRectangle against the provided BoundingRectangle componentwise and returns
      * <code>true</code> if they are equal, <code>false</code> otherwise.
-     * @memberof BoundingRectangle
      *
      * @param {BoundingRectangle} [right] The right hand side BoundingRectangle.
      * @returns {Boolean} <code>true</code> if they are equal, <code>false</code> otherwise.

Source/Core/BoundingSphere.js

@@ -70,7 +70,6 @@ define([
      * Computes a tight-fitting bounding sphere enclosing a list of 3D Cartesian points.
      * The bounding sphere is computed by running two algorithms, a naive algorithm and
      * Ritter's algorithm. The smaller of the two spheres is used to ensure a tight fit.
-     * @memberof BoundingSphere
      *
      * @param {Cartesian3[]} positions An array of points that the bounding sphere will enclose.  Each point must have <code>x</code>, <code>y</code>, and <code>z</code> properties.
      * @param {BoundingSphere} [result] The object onto which to store the result.
@@ -222,8 +221,6 @@ define([
     /**
      * Computes a bounding sphere from an rectangle projected in 2D.
      *
-     * @memberof BoundingSphere
-     *
      * @param {Rectangle} rectangle The rectangle around which to create a bounding sphere.
      * @param {Object} [projection=GeographicProjection] The projection used to project the rectangle into 2D.
      * @param {BoundingSphere} [result] The object onto which to store the result.
@@ -237,8 +234,6 @@ define([
      * Computes a bounding sphere from an rectangle projected in 2D.  The bounding sphere accounts for the
      * object's minimum and maximum heights over the rectangle.
      *
-     * @memberof BoundingSphere
-     *
      * @param {Rectangle} rectangle The rectangle around which to create a bounding sphere.
      * @param {Object} [projection=GeographicProjection] The projection used to project the rectangle into 2D.
      * @param {Number} [minimumHeight=0.0] The minimum height over the rectangle.
@@ -284,7 +279,6 @@ define([
     /**
      * Computes a bounding sphere from an rectangle in 3D. The bounding sphere is created using a subsample of points
      * on the ellipsoid and contained in the rectangle. It may not be accurate for all rectangles on all types of ellipsoids.
-     * @memberof BoundingSphere
      *
      * @param {Rectangle} rectangle The valid rectangle used to create a bounding sphere.
      * @param {Ellipsoid} [ellipsoid=Ellipsoid.WGS84] The ellipsoid used to determine positions of the rectangle.
@@ -310,8 +304,6 @@ define([
      * algorithms, a naive algorithm and Ritter's algorithm. The smaller of the two spheres is used to
      * ensure a tight fit.
      *
-     * @memberof BoundingSphere
-     *
      * @param {Cartesian3[]} positions An array of points that the bounding sphere will enclose.  Each point
      *        is formed from three elements in the array in the order X, Y, Z.
      * @param {Cartesian3} [center=Cartesian3.ZERO] The position to which the positions are relative, which need not be the
@@ -494,8 +486,6 @@ define([
      * Computes a bounding sphere from the corner points of an axis-aligned bounding box.  The sphere
      * tighly and fully encompases the box.
      *
-     * @memberof BoundingSphere
-     *
      * @param {Number} [corner] The minimum height over the rectangle.
      * @param {Number} [oppositeCorner] The maximum height over the rectangle.
      * @param {BoundingSphere} [result] The object onto which to store the result.
@@ -527,8 +517,6 @@ define([
     /**
      * Creates a bounding sphere encompassing an ellipsoid.
      *
-     * @memberof BoundingSphere
-     *
      * @param {Ellipsoid} ellipsoid The ellipsoid around which to create a bounding sphere.
      * @param {BoundingSphere} [result] The object onto which to store the result.
      *
@@ -555,7 +543,6 @@ define([
 
     /**
      * Duplicates a BoundingSphere instance.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} sphere The bounding sphere to duplicate.
      * @param {BoundingSphere} [result] The object onto which to store the result.
@@ -583,7 +570,6 @@ define([
 
     /**
      * Stores the provided instance into the provided array.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} value The value to pack.
      * @param {Number[]} array The array to pack into.
@@ -611,7 +597,6 @@ define([
 
     /**
      * Retrieves an instance from a packed array.
-     * @memberof BoundingSphere
      *
      * @param {Number[]} array The packed array.
      * @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
@@ -642,7 +627,6 @@ define([
     var unionScratchCenter = new Cartesian3();
     /**
      * Computes a bounding sphere that contains both the left and right bounding spheres.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} left A sphere to enclose in a bounding sphere.
      * @param {BoundingSphere} right A sphere to enclose in a bounding sphere.
@@ -682,7 +666,6 @@ define([
     var expandScratch = new Cartesian3();
     /**
      * Computes a bounding sphere by enlarging the provided sphere to contain the provided point.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} sphere A sphere to expand.
      * @param {Cartesian3} point A point to enclose in a bounding sphere.
@@ -712,7 +695,6 @@ define([
 
     /**
      * Determines which side of a plane a sphere is located.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} sphere The bounding sphere to test.
      * @param {Cartesian4} plane The coefficients of the plane in the for ax + by + cz + d = 0
@@ -750,7 +732,6 @@ define([
 
     /**
      * Applies a 4x4 affine transformation matrix to a bounding sphere.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} sphere The bounding sphere to apply the transformation to.
      * @param {Matrix4} transform The transformation matrix to apply to the bounding sphere.
@@ -782,7 +763,6 @@ define([
 
     /**
      * Computes the estimated distance squared from the closest point on a bounding sphere to a point.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} sphere The sphere.
      * @param {Cartesian3} cartesian The point
@@ -812,7 +792,6 @@ define([
      * Applies a 4x4 affine transformation matrix to a bounding sphere where there is no scale
      * The transformation matrix is not verified to have a uniform scale of 1.
      * This method is faster than computing the general bounding sphere transform using {@link BoundingSphere.transform}.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} sphere The bounding sphere to apply the transformation to.
      * @param {Matrix4} transform The transformation matrix to apply to the bounding sphere.
@@ -852,7 +831,6 @@ define([
      * <br>
      * If you imagine the infinite number of planes with normal direction, this computes the smallest distance to the
      * closest and farthest planes from position that intersect the bounding sphere.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} sphere The bounding sphere to calculate the distance to.
      * @param {Cartesian3} position The position to calculate the distance from.
@@ -901,7 +879,6 @@ define([
     var projectTo2DProjection = new GeographicProjection();
     /**
      * Creates a bounding sphere in 2D from a bounding sphere in 3D world coordinates.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} sphere The bounding sphere to transform to 2D.
      * @param {Object} [projection=GeographicProjection] The projection to 2D.
@@ -1003,7 +980,6 @@ define([
     /**
      * Compares the provided BoundingSphere componentwise and returns
      * <code>true</code> if they are equal, <code>false</code> otherwise.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} [left] The first BoundingSphere.
      * @param {BoundingSphere} [right] The second BoundingSphere.
@@ -1019,7 +995,6 @@ define([
 
     /**
      * Determines which side of a plane the sphere is located.
-     * @memberof BoundingSphere
      *
      * @param {Cartesian4} plane The coefficients of the plane in the for ax + by + cz + d = 0
      *                           where the coefficients a, b, c, and d are the components x, y, z,
@@ -1036,7 +1011,6 @@ define([
     /**
      * Compares this BoundingSphere against the provided BoundingSphere componentwise and returns
      * <code>true</code> if they are equal, <code>false</code> otherwise.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} [right] The right hand side BoundingSphere.
      * @returns {Boolean} <code>true</code> if they are equal, <code>false</code> otherwise.
@@ -1047,7 +1021,6 @@ define([
 
     /**
      * Duplicates this BoundingSphere instance.
-     * @memberof BoundingSphere
      *
      * @param {BoundingSphere} [result] The object onto which to store the result.
      * @returns {BoundingSphere} The modified result parameter or a new BoundingSphere instance if none was provided.

Source/Core/BoxGeometry.js

@@ -73,7 +73,6 @@ define([
 
     /**
      * Creates a cube centered at the origin given its dimensions.
-     * @memberof BoxGeometry
      *
      * @param {Cartesian3} options.dimensions The width, depth, and height of the box stored in the x, y, and z coordinates of the <code>Cartesian3</code>, respectively.
      * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
@@ -116,7 +115,6 @@ define([
 
     /**
      * Computes the geometric representation of a box, including its vertices, indices, and a bounding sphere.
-     * @memberof BoxGeometry
      *
      * @param {BoxGeometry} boxGeometry A description of the box.
      * @returns {Geometry} The computed vertices and indices.