diff --git a/geo/src/algorithm/geodesic_destination.rs b/geo/src/algorithm/geodesic_destination.rs index d31a15427..de92c06c9 100644 --- a/geo/src/algorithm/geodesic_destination.rs +++ b/geo/src/algorithm/geodesic_destination.rs @@ -2,13 +2,13 @@ use crate::Point; use geographiclib_rs::{Geodesic, DirectGeodesic}; use geo_types::CoordNum; -/// Returns a new Point using the distance to the existing Point and a bearing for the direction on a geodesic +/// Returns a new Point using the distance to the existing Point and a bearing for the direction on a geodesic. /// /// This uses the geodesic methods given by [Karney (2013)]. /// /// [Karney (2013)]: https://arxiv.org/pdf/1109.4448.pdf pub trait GeodesicDestination { - /// Returns a new Point using distance to the existing Point and a bearing for the direction + /// Returns a new Point using distance to the existing Point and a bearing for the direction. /// /// # Units /// diff --git a/geo/src/lib.rs b/geo/src/lib.rs index dd46555ec..e781c5eb0 100644 --- a/geo/src/lib.rs +++ b/geo/src/lib.rs @@ -70,6 +70,7 @@ //! ## Query //! //! - **[`Bearing`](Bearing)**: Calculate the bearing between points +//! - **[`GeodesicBearing`](GeodesicBearing)**: Calculate the bearing between points on a [geodesic](https://en.wikipedia.org/wiki/Geodesics_on_an_ellipsoid) //! - **[`ClosestPoint`](ClosestPoint)**: Find the point on a geometry //! closest to a given point //! - **[`IsConvex`](IsConvex)**: Calculate the convexity of a @@ -142,8 +143,10 @@ //! ## Miscellaneous //! //! - **[`Centroid`](Centroid)**: Calculate the centroid of a geometry -//! - **[`HaversineDestination`](HaversineDestination)**: -//! - **[`HaversineIntermediate`](HaversineIntermediate)**: +//! - **[`GeodesicDestination`](GeodesicDestination)**: Given a start point, bearing, and distance, calculate the destination point on a [geodesic](https://en.wikipedia.org/wiki/Geodesics_on_an_ellipsoid) +//! - **[`GeodesicIntermediate`](GeodesicIntermediate)**: Calculate intermediate points on a [geodesic](https://en.wikipedia.org/wiki/Geodesics_on_an_ellipsoid) +//! - **[`HaversineDestination`](HaversineDestination)**: Given a start point, bearing, and distance, calculate the destination point on a sphere +//! - **[`HaversineIntermediate`](HaversineIntermediate)**: Calculate intermediate points on a sphere //! - **[`proj`](proj)**: Project geometries with the `proj` crate (requires the `use-proj` feature) //! - **[`ChaikinSmoothing`](ChaikinSmoothing)**: Smoothen `LineString`, `Polygon`, `MultiLineString` and `MultiPolygon` using Chaikins algorithm. //! - **[`Densify`](Densify)**: Densify linear geometry components by interpolating points