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/MGLLight.h | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

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

diff --git a/platform/darwin/src/MGLLight.h b/platform/darwin/src/MGLLight.h
index 13c925d9bd..52bda1fecd 100644
--- a/platform/darwin/src/MGLLight.h
+++ b/platform/darwin/src/MGLLight.h
@@ -40,11 +40,11 @@ typedef struct __attribute__((objc_boxable)) MGLSphericalPosition {
 
 /**
  Creates a new `MGLSphericalPosition` from the given radial, azimuthal, polar.
- 
+
  @param radial The radial coordinate.
  @param azimuthal The azimuthal angle.
  @param polar The polar angle.
- 
+
  @return Returns a `MGLSphericalPosition` struct containing the position attributes.
  */
 NS_INLINE MGLSphericalPosition MGLSphericalPositionMake(CGFloat radial, CLLocationDirection azimuthal, CLLocationDirection polar) {
@@ -52,12 +52,19 @@ NS_INLINE MGLSphericalPosition MGLSphericalPositionMake(CGFloat radial, CLLocati
     position.radial = radial;
     position.azimuthal = azimuthal;
     position.polar = polar;
-    
+
     return position;
 }
 
 /**
- An `MGLLight` object represents the light source for extruded geometries in `MGLStyle`.
+  An `MGLLight` object represents the light source for extruded geometries in
+ `MGLStyle`.
+ 
+ #### Related examples
+ See the <a
+ href="https://www.mapbox.com/ios-sdk/maps/examples/light-example/">Adjust light
+ of 3D buildings</a> to learn how to create and modify the light source for 3D
+ geometries.
  */
 MGL_EXPORT
 @interface MGLLight : NSObject
@@ -118,6 +125,12 @@ MGL_EXPORT
  This property corresponds to the <a
  href="https://www.mapbox.com/mapbox-gl-js/style-spec/#light-position"><code>position</code></a>
  light property in the Mapbox Style Specification.
+
+ #### Related examples
+ See the <a
+ href="https://www.mapbox.com/ios-sdk/maps/examples/light-example/">Adjust light
+ of 3D buildings</a> example to learn how to create and modify the position of
+ value of an `MGLLight` object for 3D geometries.
  */
 @property (nonatomic) NSExpression *position;
 
-- 
cgit v1.2.1