summaryrefslogtreecommitdiff
path: root/platform/ios/src/MGLUserLocation.h
diff options
context:
space:
mode:
authorJason Wray <friedbunny@users.noreply.github.com>2016-07-22 15:01:19 -0400
committerGitHub <noreply@github.com>2016-07-22 15:01:19 -0400
commit0ea6bdd7fe61ea5e03d9dbfd9142a3aedf1559fb (patch)
tree1f9a035ece17d481638c2e527463c3e8e42c8e3b /platform/ios/src/MGLUserLocation.h
parente33b9981cb7e0e909198c11690a571cacd2e27bb (diff)
downloadqtlocation-mapboxgl-0ea6bdd7fe61ea5e03d9dbfd9142a3aedf1559fb.tar.gz
[ios] Reformat inline documentation with ticks, smart quotes, breaks (#5752)
- Makes the use of apostrophes in the iOS SDK documentation consistent by converting “dumb” `'` into smart `’`. - Adds ticks around class/property names/values. - Breaks lines at 80 characters.
Diffstat (limited to 'platform/ios/src/MGLUserLocation.h')
-rw-r--r--platform/ios/src/MGLUserLocation.h18
1 files changed, 14 insertions, 4 deletions
diff --git a/platform/ios/src/MGLUserLocation.h b/platform/ios/src/MGLUserLocation.h
index 6160413510..81f9557b16 100644
--- a/platform/ios/src/MGLUserLocation.h
+++ b/platform/ios/src/MGLUserLocation.h
@@ -7,7 +7,12 @@
NS_ASSUME_NONNULL_BEGIN
-/** The MGLUserLocation class defines a specific type of annotation that identifies the user’s current location. You do not create instances of this class directly. Instead, you retrieve an existing MGLUserLocation object from the userLocation property of the map view displayed in your application. */
+/**
+ The MGLUserLocation class defines a specific type of annotation that identifies
+ the user’s current location. You do not create instances of this class
+ directly. Instead, you retrieve an existing MGLUserLocation object from the
+ `userLocation` property of the map view displayed in your application.
+ */
@interface MGLUserLocation : NSObject <MGLAnnotation>
#pragma mark Determining the User’s Position
@@ -15,17 +20,22 @@ NS_ASSUME_NONNULL_BEGIN
/**
The current location of the device. (read-only)
- This property contains `nil` if the map view is not currently showing the user location or if the user’s location has not yet been determined.
+ This property contains `nil` if the map view is not currently showing the user
+ location or if the user’s location has not yet been determined.
*/
@property (nonatomic, readonly, nullable) CLLocation *location;
-/** A Boolean value indicating whether the user’s location is currently being updated. (read-only) */
+/**
+ A Boolean value indicating whether the user’s location is currently being
+ updated. (read-only)
+ */
@property (nonatomic, readonly, getter=isUpdating) BOOL updating;
/**
The heading of the user location. (read-only)
- This property is `nil` if the user location tracking mode is not `MGLUserTrackingModeFollowWithHeading`.
+ This property is `nil` if the user location tracking mode is not
+ `MGLUserTrackingModeFollowWithHeading`.
*/
@property (nonatomic, readonly, nullable) CLHeading *heading;