Authored by Justin R. Miller

docs fixes

... ... @@ -50,12 +50,16 @@
/** @name Creating Tile Sources */
/** Initialize and return a newly allocated MBTiles tile source based on a given bundle resource with the extension `.mbtiles`. */
/** Initialize and return a newly allocated MBTiles tile source based on a given bundle resource with the extension `.mbtiles`.
*
* @param name The name of the resource file. If name is an empty string or `nil`, uses the first file encountered with the extension `.mbtiles`.
* @return An initialized MBTiles tile source. */
- (id)initWithTileSetResource:(NSString *)name;
/** Initialize and return a newly allocated MBTiles tile source based on a given bundle resource.
* @param name The name of the resource file. If name is an empty string or `nil`, uses the first file encountered of the supplied type.
* @param extension If extension is an empty string or `nil`, the extension is assumed not to exist and the file is the first file encountered that exactly matches name. */
* @param extension If extension is an empty string or `nil`, the extension is assumed not to exist and the file is the first file encountered that exactly matches name.
* @return An initialized MBTiles tile source. */
- (id)initWithTileSetResource:(NSString *)name ofType:(NSString *)extension;
/** Initialize and return a newly allocated MBTiles tile source based on a given local database URL.
... ...
... ... @@ -125,7 +125,9 @@ typedef enum : NSUInteger {
/** A custom, static view to use behind the map tiles. The default behavior is to use grid imagery that moves with map panning like MapKit. */
@property (nonatomic, strong) UIView *backgroundView;
/** A custom image to use behind the map tiles. The default behavior is to show the default `backgroundView` and not a static image. */
/** A custom image to use behind the map tiles. The default behavior is to show the default `backgroundView` and not a static image.
*
* @param backgroundImage The image to use. */
- (void)setBackgroundImage:(UIImage *)backgroundImage;
/** A Boolean value indicating whether to draw tile borders and z/x/y numbers on tile images for debugging purposes. Defaults to `NO`. */
... ... @@ -138,7 +140,10 @@ typedef enum : NSUInteger {
/** @name Initializing a Map View */
/** Initialize a map view with a given frame. A default watermarked Mapbox map tile source will be used. */
/** Initialize a map view with a given frame. A default watermarked Mapbox map tile source will be used.
*
* @param frame The frame with which to initialize the map view.
* @return An initialized map view, or `nil` if the map view was unable to be initialized. */
- (id)initWithFrame:(CGRect)frame;
/** Initialize a map view with a given frame and tile source.
... ...
... ... @@ -176,7 +176,7 @@ typedef enum : NSUInteger {
- (void)tapOnCalloutAccessoryControl:(UIControl *)control forAnnotation:(RMAnnotation *)annotation onMap:(RMMapView *)map;
/** Asks the delegate whether the user should be allowed to drag the layer for an annotation.
* @param map The map view.
* @param mapView The map view.
* @param annotation The annotation the user is attempting to drag.
* @return A Boolean value indicating whether the user should be allowed to drag the annotation's layer. */
- (BOOL)mapView:(RMMapView *)mapView shouldDragAnnotation:(RMAnnotation *)annotation;
... ... @@ -185,7 +185,7 @@ typedef enum : NSUInteger {
*
* The drag state typically changes in response to user interactions with the annotation layer. However, the annotation layer itself is responsible for changing that state as well.
* @param mapView The map view containing the annotation layer.
* @param annotationLayer The annotation layer whose drag state changed.
* @param annotation The annotation whose drag state changed.
* @param newState The new drag state of the annotation layer.
* @param oldState The previous drag state of the annotation layer. */
- (void)mapView:(RMMapView *)mapView annotation:(RMAnnotation *)annotation didChangeDragState:(RMMapLayerDragState)newState fromOldState:(RMMapLayerDragState)oldState;
... ...