[ios, osx] Clarified documentation

Updated MGLTilePyramidOfflineRegion documentation to note that local files can’t be used as style URLs. Added documentation for private offline methods.

1 files changed, 11 insertions, 0 deletions

diff --git a/platform/darwin/src/MGLOfflineRegion_Private.h b/platform/darwin/src/MGLOfflineRegion_Private.h
index 41cd5843f6..22106987d0 100644
--- a/platform/darwin/src/MGLOfflineRegion_Private.h
+++ b/platform/darwin/src/MGLOfflineRegion_Private.h
@@ -8,8 +8,19 @@ NS_ASSUME_NONNULL_BEGIN
 
 @protocol MGLOfflineRegion_Private <MGLOfflineRegion>
 
+/**
+ Initializes and returns an offline region backed by the given C++ region
+ definition object.
+ 
+ @param definition A reference to an offline region definition backing the
+    offline region.
+ */
 - (instancetype)initWithOfflineRegionDefinition:(const mbgl::OfflineRegionDefinition &)definition;
 
+/**
+ Creates and returns a C++ offline region definition corresponding to the
+ receiver.
+ */
 - (const mbgl::OfflineRegionDefinition)offlineRegionDefinition;
 
 @end