Authored by Justin R. Miller

doc clarifications

@@ -89,6 +89,7 @@ @@ -89,6 +89,7 @@
89 /** @name Representing an Annotation Visually */ 89 /** @name Representing an Annotation Visually */
90 90
91 /** An object representing the annotation's visual appearance. 91 /** An object representing the annotation's visual appearance.
  92 +*
92 * @see RMMarker 93 * @see RMMarker
93 * @see RMShape 94 * @see RMShape
94 * @see RMCircle */ 95 * @see RMCircle */
@@ -62,12 +62,20 @@ typedef enum : NSUInteger { @@ -62,12 +62,20 @@ typedef enum : NSUInteger {
62 /** @name Creating Tile Sources */ 62 /** @name Creating Tile Sources */
63 63
64 /** Initialize a tile source using the MapBox map ID. 64 /** Initialize a tile source using the MapBox map ID.
  65 +*
  66 +* This method requires a network connection in order to download the TileJSON used to define the tile source.
  67 +*
65 * @param mapID The MapBox map ID string, typically in the format `<username>.map-<random characters>`. 68 * @param mapID The MapBox map ID string, typically in the format `<username>.map-<random characters>`.
66 * @return An initialized MapBox tile source. */ 69 * @return An initialized MapBox tile source. */
67 - (id)initWithMapID:(NSString *)mapID; 70 - (id)initWithMapID:(NSString *)mapID;
68 71
69 /** Initialize a tile source with either a remote or local TileJSON structure. 72 /** Initialize a tile source with either a remote or local TileJSON structure.
70 -* @param referenceURL A remote or local URL pointing to a TileJSON structure. 73 +*
  74 +* Passing a remote URL requires a network connection. If offline functionality is desired, you should cache the TileJSON locally at a prior date, then pass a file path URL to this method.
  75 +*
  76 +* @see tileJSON
  77 +*
  78 +* @param referenceURL A remote or file path URL pointing to a TileJSON structure.
71 * @return An initialized MapBox tile source. */ 79 * @return An initialized MapBox tile source. */
72 - (id)initWithReferenceURL:(NSURL *)referenceURL; 80 - (id)initWithReferenceURL:(NSURL *)referenceURL;
73 81
@@ -77,19 +85,27 @@ typedef enum : NSUInteger { @@ -77,19 +85,27 @@ typedef enum : NSUInteger {
77 - (id)initWithTileJSON:(NSString *)tileJSON; 85 - (id)initWithTileJSON:(NSString *)tileJSON;
78 86
79 /** For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from [simplestyle](http://mapbox.com/developers/simplestyle/) data. 87 /** For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from [simplestyle](http://mapbox.com/developers/simplestyle/) data.
  88 +*
  89 +* This method requires a network connection in order to download the TileJSON used to define the tile source.
  90 +*
80 * @param mapID The MapBox map ID string, typically in the format `<username>.map-<random characters>`. 91 * @param mapID The MapBox map ID string, typically in the format `<username>.map-<random characters>`.
81 * @param mapView A map view on which to display the annotations. 92 * @param mapView A map view on which to display the annotations.
82 * @return An initialized MapBox tile source. */ 93 * @return An initialized MapBox tile source. */
83 - (id)initWithMapID:(NSString *)mapID enablingDataOnMapView:(RMMapView *)mapView; 94 - (id)initWithMapID:(NSString *)mapID enablingDataOnMapView:(RMMapView *)mapView;
84 95
85 /** For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from [simplestyle](http://mapbox.com/developers/simplestyle/) data. 96 /** For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from [simplestyle](http://mapbox.com/developers/simplestyle/) data.
86 -* @param tileJSON A string containing TileJSON. 97 +* @param tileJSON A string containing TileJSON.
87 * @param mapView A map view on which to display the annotations. 98 * @param mapView A map view on which to display the annotations.
88 * @return An initialized MapBox tile source. */ 99 * @return An initialized MapBox tile source. */
89 - (id)initWithTileJSON:(NSString *)tileJSON enablingDataOnMapView:(RMMapView *)mapView; 100 - (id)initWithTileJSON:(NSString *)tileJSON enablingDataOnMapView:(RMMapView *)mapView;
90 101
91 /** For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from [simplestyle](http://mapbox.com/developers/simplestyle/) data. 102 /** For TileJSON 2.1.0+ layers, initialize a tile source and automatically find and add annotations from [simplestyle](http://mapbox.com/developers/simplestyle/) data.
92 -* @param referenceURL A remote or local URL pointing to a TileJSON structure. 103 +*
  104 +* Passing a remote URL requires a network connection. If offline functionality is desired, you should cache the TileJSON locally at a prior date, then pass a file path URL to this method.
  105 +*
  106 +* @see tileJSON
  107 +*
  108 +* @param referenceURL A remote or file path URL pointing to a TileJSON structure.
93 * @param mapView A map view on which to display the annotations. 109 * @param mapView A map view on which to display the annotations.
94 * @return An initialized MapBox tile source. */ 110 * @return An initialized MapBox tile source. */
95 - (id)initWithReferenceURL:(NSURL *)referenceURL enablingDataOnMapView:(RMMapView *)mapView; 111 - (id)initWithReferenceURL:(NSURL *)referenceURL enablingDataOnMapView:(RMMapView *)mapView;
@@ -117,6 +133,8 @@ typedef enum : NSUInteger { @@ -117,6 +133,8 @@ typedef enum : NSUInteger {
117 /** The TileJSON data in dictionary format. Useful for retrieving info about the layer without having to parse TileJSON. */ 133 /** The TileJSON data in dictionary format. Useful for retrieving info about the layer without having to parse TileJSON. */
118 @property (nonatomic, readonly, strong) NSDictionary *infoDictionary; 134 @property (nonatomic, readonly, strong) NSDictionary *infoDictionary;
119 135
  136 +/** @name Configuring Map Options */
  137 +
120 /** Image quality that is retrieved from the network. Useful for lower-bandwidth environments. The default is to provide full-quality imagery. 138 /** Image quality that is retrieved from the network. Useful for lower-bandwidth environments. The default is to provide full-quality imagery.
121 * 139 *
122 * Note that you may want to clear the tile cache after changing this value in order to provide a consistent experience. */ 140 * Note that you may want to clear the tile cache after changing this value in order to provide a consistent experience. */