Maintenance scheduled for Thursday, January 27th at 15:00 MST. Expected downtime <1 hour.

Commit 42f9ca7d authored by Jeremy M Fee's avatar Jeremy M Fee Committed by Edward J Hunter
Browse files

Add comment to getDistanceAzimuth method

parent 2392bae6
......@@ -9,6 +9,18 @@ export interface DistanceAzimuth {
distance: number;
}
/**
* Compute distance and azimuth from place to reference place.
*
* @param place
* starting place.
* @param referencePlace
* optional destination place.
* @return
* When reference place is specified:
* calculate direction and azimuth from place to referencePlace.
* Otherwise return distance and azimuth from place.
*/
export function getDistanceAzimuth(
place: Place,
referencePlace?: Place
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment