From 9cbccb662ee0cfb737fdeb59543c99be12e1cb7d Mon Sep 17 00:00:00 2001 From: Jason Wray Date: Fri, 23 Oct 2015 15:33:49 -0400 Subject: [PATCH] [ios] document willStart/didFinish map loading delegate methods Fixes #2706 --- include/mbgl/ios/MGLMapView.h | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/include/mbgl/ios/MGLMapView.h b/include/mbgl/ios/MGLMapView.h index c715725bd..93532b6a3 100644 --- a/include/mbgl/ios/MGLMapView.h +++ b/include/mbgl/ios/MGLMapView.h @@ -414,14 +414,20 @@ IB_DESIGNABLE * @param animated Whether the change caused an animated effect on the map. */ - (void)mapView:(MGLMapView *)mapView regionDidChangeAnimated:(BOOL)animated; -#pragma mark - Loading the Map Data +#pragma mark - Loading the Map -/** @name Loading the Map Data */ +/** @name Loading the Map */ -// TODO +/** Tells the delegate that the map view will begin to load. + * + * This method is called whenever the map view starts loading, including when a new style has been set and the map must reload. + * @param mapView The map view that is starting to load. */ - (void)mapViewWillStartLoadingMap:(MGLMapView *)mapView; -// TODO +/** Tells the delegate that the map view has finished loading. + * + * This method is called whenever the map view finishes loading, either after the initial load or after a style change has forced a reload. + * @param mapView The map view that has finished loading. */ - (void)mapViewDidFinishLoadingMap:(MGLMapView *)mapView; // TODO