summaryrefslogtreecommitdiff
path: root/platform/ios/src/MGLCalloutView.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/MGLCalloutView.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/MGLCalloutView.h')
-rw-r--r--platform/ios/src/MGLCalloutView.h36
1 files changed, 25 insertions, 11 deletions
diff --git a/platform/ios/src/MGLCalloutView.h b/platform/ios/src/MGLCalloutView.h
index 641976dfee..27d173b230 100644
--- a/platform/ios/src/MGLCalloutView.h
+++ b/platform/ios/src/MGLCalloutView.h
@@ -8,32 +8,38 @@ NS_ASSUME_NONNULL_BEGIN
@protocol MGLAnnotation;
/**
- A protocol for a `UIView` subclass that displays information about a selected annotation near that annotation.
+ A protocol for a `UIView` subclass that displays information about a selected
+ annotation near that annotation.
*/
@protocol MGLCalloutView <NSObject>
/**
- An object conforming to the `MGLAnnotation` protocol whose details this callout view displays.
+ An object conforming to the `MGLAnnotation` protocol whose details this callout
+ view displays.
*/
@property (nonatomic, strong) id <MGLAnnotation> representedObject;
/**
- A view that the user may tap to perform an action. This view is conventionally positioned on the left side of the callout view.
+ A view that the user may tap to perform an action. This view is conventionally
+ positioned on the left side of the callout view.
*/
@property (nonatomic, strong) UIView *leftAccessoryView;
/**
- A view that the user may tap to perform an action. This view is conventionally positioned on the right side of the callout view.
+ A view that the user may tap to perform an action. This view is conventionally
+ positioned on the right side of the callout view.
*/
@property (nonatomic, strong) UIView *rightAccessoryView;
/**
- An object conforming to the `MGLCalloutViewDelegate` method that receives messages related to the callout view’s interactive subviews.
+ An object conforming to the `MGLCalloutViewDelegate` method that receives
+ messages related to the callout view’s interactive subviews.
*/
@property (nonatomic, weak) id<MGLCalloutViewDelegate> delegate;
/**
- Presents a callout view by adding it to `inView` and pointing at the given rect of `inView`’s bounds. Constrains the callout to the bounds of the given view.
+ Presents a callout view by adding it to `view` and pointing at the given rect
+ of `view`’s bounds. Constrains the callout to the bounds of the given view.
*/
- (void)presentCalloutFromRect:(CGRect)rect inView:(UIView *)view constrainedToView:(UIView *)constrainedView animated:(BOOL)animated;
@@ -45,15 +51,21 @@ NS_ASSUME_NONNULL_BEGIN
@end
/**
- The MGLCalloutViewDelegate protocol defines a set of optional methods that you can use to receive messages from an object that conforms to the MGLCalloutView protocol. The callout view uses these methods to inform the delegate that the user has interacted with the the callout view.
+ The `MGLCalloutViewDelegate` protocol defines a set of optional methods that
+ you can use to receive messages from an object that conforms to the
+ `MGLCalloutView` protocol. The callout view uses these methods to inform the
+ delegate that the user has interacted with the the callout view.
*/
@protocol MGLCalloutViewDelegate <NSObject>
@optional
/**
- Returns a Boolean value indicating whether the entire callout view “highlights” when tapped. The default value is `YES`, which means the callout view highlights when tapped.
+ Returns a Boolean value indicating whether the entire callout view “highlights”
+ when tapped. The default value is `YES`, which means the callout view
+ highlights when tapped.
- The return value of this method is ignored unless the delegate also responds to the `-calloutViewTapped` method.
+ The return value of this method is ignored unless the delegate also responds to
+ the `-calloutViewTapped` method.
*/
- (BOOL)calloutViewShouldHighlight:(UIView<MGLCalloutView> *)calloutView;
@@ -63,12 +75,14 @@ NS_ASSUME_NONNULL_BEGIN
- (void)calloutViewTapped:(UIView<MGLCalloutView> *)calloutView;
/**
- Called before the callout view appears on screen, or before the appearance animation will start.
+ Called before the callout view appears on screen, or before the appearance
+ animation will start.
*/
- (void)calloutViewWillAppear:(UIView<MGLCalloutView> *)calloutView;
/**
- Called after the callout view appears on screen, or after the appearance animation is complete.
+ Called after the callout view appears on screen, or after the appearance
+ animation is complete.
*/
- (void)calloutViewDidAppear:(UIView<MGLCalloutView> *)calloutView;