Changes to API docs per Dennis

This commit is contained in:
Rand McKinney 2015-05-04 08:45:17 -07:00
parent ef0a10dbb6
commit 0b235015f0
1 changed files with 8 additions and 4 deletions

View File

@ -84,7 +84,8 @@ exports.GeoPoint = GeoPoint;
* For example:
*
* ```js
* var here = new GeoPoint({lat: 10.32424, lng: 5.84978});
* var loopback = require(loopback);
* var here = new loopback.GeoPoint({lat: 10.32424, lng: 5.84978});
* ```
*
* Embed a latitude / longitude point in a model.
@ -196,9 +197,12 @@ GeoPoint.distanceBetween = function distanceBetween(a, b, options) {
* Determine the spherical distance to the given point.
* Example:
* ```js
* var here = new GeoPoint({lat: 10, lng: 10});
* var there = new GeoPoint({lat: 5, lng: 5});
* GeoPoint.distanceBetween(here, there, {type: 'miles'}) // 438
* var loopback = require(loopback);
*
* var here = new loopback.GeoPoint({lat: 10, lng: 10});
* var there = new loopback.GeoPoint({lat: 5, lng: 5});
*
* loopback.GeoPoint.distanceBetween(here, there, {type: 'miles'}) // 438
* ```
* @param {Object} point GeoPoint object to which to measure distance.
* @options {Object} options Options object with one key, 'type'. See below.