From 271b78c1309dd9391e9fc315e9d9873381f5999d Mon Sep 17 00:00:00 2001
From: Josh Erb <josh.erb@mapbox.com>
Date: Tue, 30 Oct 2018 18:03:56 -0400
Subject: [ios][documentation] link API documentation to ios-sdk/examples

---
 platform/darwin/src/MGLGeometry.h | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'platform/darwin/src/MGLGeometry.h')

diff --git a/platform/darwin/src/MGLGeometry.h b/platform/darwin/src/MGLGeometry.h
index c3450359aa..997ff285e2 100644
--- a/platform/darwin/src/MGLGeometry.h
+++ b/platform/darwin/src/MGLGeometry.h
@@ -146,7 +146,15 @@ NS_INLINE BOOL MGLCoordinateBoundsIntersectsCoordinateBounds(MGLCoordinateBounds
             bounds1.sw.longitude < bounds2.ne.longitude);
 }
 
-/** Returns `YES` if the coordinate is within the coordinate bounds. */
+/**
+ Returns `YES` if the coordinate is within the coordinate bounds.
+ 
+ #### Related examples
+ See the <a href="https://www.mapbox.com/ios-sdk/maps/examples/constraining-gestures/">
+ Restrict map panning to an area</a> example to learn how to use
+ `MGLCoordinateInCoordinateBounds` to determine if a point is within, or
+ intersects, a given bounding box.
+ */
 NS_INLINE BOOL MGLCoordinateInCoordinateBounds(CLLocationCoordinate2D coordinate, MGLCoordinateBounds bounds) {
     return (coordinate.latitude  >= bounds.sw.latitude  &&
             coordinate.latitude  <= bounds.ne.latitude  &&
-- 
cgit v1.2.1