Add documenation to did fail to load image (#1365)

maplibre · Jul 13, 2023 · 1df69db · 1df69db
1 parent 14cc029
commit 1df69db
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/platform/ios/platform/ios/src/MLNMapViewDelegate.h b/platform/ios/platform/ios/src/MLNMapViewDelegate.h
@@ -276,6 +276,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)mapView:(MLNMapView *)mapView didFinishLoadingStyle:(MLNStyle *)style;
 
+/**
+ Tells the delegate that the `mapView` is missing an image. The image should be added synchronously with `-[MLNStyle setImage:forName:]` to be rendered on the current zoom level. When loading icons asynchronously, you can load a placeholder image and replace it when your image has loaded.
+
+ @param mapView The map view that is loading the image.
+ @param imageName The name of the image that is missing.
+ */
 - (nullable UIImage *)mapView:(MLNMapView *)mapView didFailToLoadImage:(NSString *)imageName;
 
 /**

diff --git a/platform/ios/platform/macos/src/MLNMapViewDelegate.h b/platform/ios/platform/macos/src/MLNMapViewDelegate.h
@@ -181,6 +181,12 @@ NS_ASSUME_NONNULL_BEGIN
  */
 - (void)mapView:(MLNMapView *)mapView didFinishLoadingStyle:(MLNStyle *)style;
 
+/**
+ Tells the delegate that the `mapView` is missing an image. The image should be added synchronously with `-[MLNStyle setImage:forName:]` to be rendered on the current zoom level. When loading icons asynchronously, you can load a placeholder image and replace it when your image has loaded.
+
+ @param mapView The map view that is loading the image.
+ @param imageName The name of the image that is missing.
+ */
 - (nullable NSImage *)mapView:(MLNMapView *)mapView didFailToLoadImage:(NSString *)imageName;
 
 /**