Improve header documentation for MGLObservable (#398)

mapbox · Sep 3, 2020 · 1458061 · 1458061
1 parent f1d117b
commit 1458061
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/platform/darwin/src/MGLObserver.h b/platform/darwin/src/MGLObserver.h
@@ -6,7 +6,8 @@ NS_ASSUME_NONNULL_BEGIN
 #pragma mark -
 
 /**
- Base class for observers used to receive notifications from an `MGLObservable`.
+ Base class for observers used to receive notifications from a type conforming to
+ the `MGLObservable` protocol.
  Subclasses should only override `-[MGLObserver notifyWithEvent:]`.
  */
 MGL_EXPORT
@@ -26,8 +27,9 @@ MGL_EXPORT
 #pragma mark -
 
 /**
- Protocol that types that wish to support subscriptions for events should conform
- to.
+ The `MGLObservable` protocol declares methods that conforming classes should
+ implement should they want to observe low-level events of type `MGLEvent`.
+ Currently only `MGLMapView` implements `MGLObservable`.
  */
 MGL_EXPORT
 @protocol MGLObservable