[ios] Generate API documentation using jazzy

Replaced appledoc usage with jazzy, which understands modern Objective-C syntax by virtue of using Clang ASTs. Nevertheless, we have to make lots of changes to our documentation syntax, which was tailored to appledocs quirks. The new syntax jives much better with what Xcode expects in terms of auto-indentation and Quick Help.

Fixes #1420.

1 files changed, 22 insertions, 15 deletions

diff --git a/include/mbgl/ios/MGLAnnotationImage.h b/include/mbgl/ios/MGLAnnotationImage.h
index f48a3cfb45..f9d9e70566 100644
--- a/include/mbgl/ios/MGLAnnotationImage.h
+++ b/include/mbgl/ios/MGLAnnotationImage.h
@@ -7,29 +7,36 @@ NS_ASSUME_NONNULL_BEGIN
 /** The MGLAnnotationImage class is responsible for presenting point-based annotations visually on a map view. Annotation image objects wrap `UIImage` objects and may be recycled later and put into a reuse queue that is maintained by the map view. */
 @interface MGLAnnotationImage : NSObject
 
-/** @name Initializing and Preparing the Image Object */
-
-/** Initializes and returns a new annotation image object.
-*   @param image The image to be displayed for the annotation.
-*   @param reuseIdentifier The string that identifies that this annotation image is reusable.
-*   @return The initialized annotation image object or `nil` if there was a problem initializing the object. */
+#pragma mark Initializing and Preparing the Image Object
+
+/**
+ Initializes and returns a new annotation image object.
+ 
+ @param image The image to be displayed for the annotation.
+ @param reuseIdentifier The string that identifies that this annotation image is reusable.
+ @return The initialized annotation image object or `nil` if there was a problem initializing the object.
+ */
 + (instancetype)annotationImageWithImage:(UIImage *)image reuseIdentifier:(NSString *)reuseIdentifier;
 
-/** @name Getting and Setting Attributes */
+#pragma mark Getting and Setting Attributes
 
 /** The image to be displayed for the annotation. */
 @property (nonatomic, strong) UIImage *image;
 
-/** The string that identifies that this annotation image is reusable. (read-only)
-*
-*   You specify the reuse identifier when you create the image object. You use this type later to retrieve an annotation image object that was created previously but which is currently unused because its annotation is not on screen.
-*
-*   If you define distinctly different types of annotations (with distinctly different annotation images to go with them), you can differentiate between the annotation types by specifying different reuse identifiers for each one. */
+/**
+ The string that identifies that this annotation image is reusable. (read-only)
+ 
+ You specify the reuse identifier when you create the image object. You use this type later to retrieve an annotation image object that was created previously but which is currently unused because its annotation is not on screen.
+ 
+ If you define distinctly different types of annotations (with distinctly different annotation images to go with them), you can differentiate between the annotation types by specifying different reuse identifiers for each one.
+ */
 @property (nonatomic, readonly) NSString *reuseIdentifier;
 
-/** A Boolean value indicating whether the annotation is enabled.
-*
-*   The default value of this property is `YES`. If the value of this property is `NO`, the annotation image ignores touch events and cannot be selected. */
+/**
+ A Boolean value indicating whether the annotation is enabled.
+ 
+ The default value of this property is `YES`. If the value of this property is `NO`, the annotation image ignores touch events and cannot be selected.
+ */
 @property (nonatomic, getter=isEnabled) BOOL enabled;
 
 @end