Skip to content
This repository has been archived by the owner on Jun 21, 2023. It is now read-only.

Update header documentation #398

Merged
merged 1 commit into from
Sep 3, 2020
Merged

Update header documentation #398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions platform/darwin/src/MGLObserver.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down