ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #2086 from fredj/apidoc

Browse Source 
Document ol.coordinate functions
This commit is contained in:
Frédéric Junod
2014-05-21 09:04:45 +02:00
parent 832371b2aa 8239a5c92a
commit c4e729a2bd
2 changed files with 20 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/ol/coordinate.js
View File

@@ -33,6 +33,9 @@ ol.CoordinateArray;
/**
* Add `delta` to `coordinate`. `coordinate` is modified in place and returned
* by the function.
*
* @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Coordinate} delta Delta.
* @return {ol.Coordinate} Coordinate.
@@ -156,8 +159,11 @@ ol.coordinate.equals = function(coordinate1, coordinate2) {
/**
* Rotate `coordinate` by `angle`. `coordinate` is modified in place and
* returned by the function.
*
* @param {ol.Coordinate} coordinate Coordinate.
* @param {number} angle Angle.
* @param {number} angle Angle in radian.
* @return {ol.Coordinate} Coordinate.
* @todo api
*/
@@ -173,18 +179,24 @@ ol.coordinate.rotate = function(coordinate, angle) {
/**
* Scale `coordinate` by `scale`. `coordinate` is modified in place and returned
* by the function.
*
* @param {ol.Coordinate} coordinate Coordinate.
* @param {number} s Scale.
* @param {number} scale Scale factor.
* @return {ol.Coordinate} Coordinate.
*/
ol.coordinate.scale = function(coordinate, s) {
coordinate[0] *= s;
coordinate[1] *= s;
ol.coordinate.scale = function(coordinate, scale) {
coordinate[0] *= scale;
coordinate[1] *= scale;
return coordinate;
};
/**
* Subtract `delta` to `coordinate`. `coordinate` is modified in place and
* returned by the function.
*
* @param {ol.Coordinate} coordinate Coordinate.
* @param {ol.Coordinate} delta Delta.
* @return {ol.Coordinate} Coordinate.

3
src/ol/coordinate.jsdoc Normal file
View File

@@ -0,0 +1,3 @@
/**
* @namespace ol.coordinate
*/