[google_maps_flutter_ios] improve obj-c documentation

Author: jokerttu

packages/google_maps_flutter/google_maps_flutter_ios/example/ios14/ios/Runner.xcodeproj/project.pbxproj

@@ -12,8 +12,8 @@
 		2BDE99378062AE3E60B40021 /* Pods_RunnerTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3ACE0AFE8D82CD5962486AFD /* Pods_RunnerTests.framework */; };
 		3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; };
 		478116522BEF8F47002F593E /* GoogleMapsPolylinesControllerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 478116512BEF8F47002F593E /* GoogleMapsPolylinesControllerTests.m */; };
-		521AB0032B876A76005F460D /* ExtractIconFromDataTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 521AB0022B876A76005F460D /* ExtractIconFromDataTests.m */; };
-		52E9C2AE2C5CEBD600078060 /* FLTClusterManagersControllerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 52E9C2AD2C5CEBD600078060 /* FLTClusterManagersControllerTests.m */; };
+		528F16832C62941000148160 /* FGMClusterManagersControllerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 528F16822C62941000148160 /* FGMClusterManagersControllerTests.m */; };
+		528F16872C62952700148160 /* ExtractIconFromDataTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 528F16862C62952700148160 /* ExtractIconFromDataTests.m */; };
 		6851F3562835BC180032B7C8 /* FLTGoogleMapJSONConversionsConversionTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 6851F3552835BC180032B7C8 /* FLTGoogleMapJSONConversionsConversionTests.m */; };
 		68E4726A2836FF0C00BDDDAC /* MapKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 68E472692836FF0C00BDDDAC /* MapKit.framework */; };
 		978B8F6F1D3862AE00F588F7 /* AppDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = 7AFFD8EE1D35381100E5BB4D /* AppDelegate.m */; };
@@ -65,9 +65,9 @@
 		3ACE0AFE8D82CD5962486AFD /* Pods_RunnerTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_RunnerTests.framework; sourceTree = BUILT_PRODUCTS_DIR; };
 		3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = "<group>"; };
 		478116512BEF8F47002F593E /* GoogleMapsPolylinesControllerTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GoogleMapsPolylinesControllerTests.m; sourceTree = "<group>"; };
-		521AB0022B876A76005F460D /* ExtractIconFromDataTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = ExtractIconFromDataTests.m; sourceTree = "<group>"; };
+		528F16822C62941000148160 /* FGMClusterManagersControllerTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FGMClusterManagersControllerTests.m; sourceTree = "<group>"; };
+		528F16862C62952700148160 /* ExtractIconFromDataTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ExtractIconFromDataTests.m; sourceTree = "<group>"; };
 		61A9A8623F5CA9BBC813DC6B /* Pods_Runner.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Runner.framework; sourceTree = BUILT_PRODUCTS_DIR; };
-		52E9C2AD2C5CEBD600078060 /* FLTClusterManagersControllerTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = FLTClusterManagersControllerTests.m; sourceTree = "<group>"; };
 		6851F3552835BC180032B7C8 /* FLTGoogleMapJSONConversionsConversionTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FLTGoogleMapJSONConversionsConversionTests.m; sourceTree = "<group>"; };
 		68E472692836FF0C00BDDDAC /* MapKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = MapKit.framework; path = Platforms/MacOSX.platform/Developer/SDKs/MacOSX12.0.sdk/System/iOSSupport/System/Library/Frameworks/MapKit.framework; sourceTree = DEVELOPER_DIR; };
 		733AFAB37683A9DA7512F09C /* Pods-RunnerTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-RunnerTests.release.xcconfig"; path = "Pods/Target Support Files/Pods-RunnerTests/Pods-RunnerTests.release.xcconfig"; sourceTree = "<group>"; };
@@ -207,8 +207,8 @@
 			isa = PBXGroup;
 			children = (
 				F269303A2BB389BF00BF17C4 /* assets */,
-				52E9C2AF2C5CECD100078060 /* ExtractIconFromDataTests.m */,
-				52E9C2AD2C5CEBD600078060 /* FGMClusterManagersControllerTests.m */,
+				528F16862C62952700148160 /* ExtractIconFromDataTests.m */,
+				528F16822C62941000148160 /* FGMClusterManagersControllerTests.m */,
 				6851F3552835BC180032B7C8 /* FLTGoogleMapJSONConversionsConversionTests.m */,
 				0DD7B6C22B744EEF00E857FD /* FLTTileProviderControllerTests.m */,
 				F7151F12265D7ED70028CB91 /* GoogleMapsTests.m */,
@@ -511,13 +511,13 @@
 			isa = PBXSourcesBuildPhase;
 			buildActionMask = 2147483647;
 			files = (
+				528F16832C62941000148160 /* FGMClusterManagersControllerTests.m in Sources */,
 				F7151F13265D7ED70028CB91 /* GoogleMapsTests.m in Sources */,
-				52E9C2AE2C5CEBD600078060 /* FGMClusterManagersControllerTests.m in Sources */,
 				6851F3562835BC180032B7C8 /* FLTGoogleMapJSONConversionsConversionTests.m in Sources */,
 				982F2A6C27BADE17003C81F4 /* PartiallyMockedMapView.m in Sources */,
 				478116522BEF8F47002F593E /* GoogleMapsPolylinesControllerTests.m in Sources */,
 				0DD7B6C32B744EEF00E857FD /* FLTTileProviderControllerTests.m in Sources */,
-				52E9C2B02C5CECD100078060 /* ExtractIconFromDataTests.m in Sources */,
+				528F16872C62952700148160 /* ExtractIconFromDataTests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FGMClusterManagersController.h

@@ -10,60 +10,51 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-// Defines cluster managers controller interface which
-// is responsible for adding/removing/returning one or more cluster managers.
+/// A controller that manages all of the cluster managers on a map.
 @interface FGMClusterManagersController : NSObject
 
-/// Initializes FLTClusterManagersController.
+/// Initializes cluster manager controller.
 ///
 /// @param callbackHandler A callback handler.
 /// @param mapView A map view that will be used to display clustered markers.
 - (instancetype)initWithMapView:(GMSMapView *)mapView
                 callbackHandler:(FGMMapsCallbackApi *)callbackHandler;
 
-/// Creates ClusterManagers and initializes them form JSON data.
+/// Creates cluster managers and initializes them form JSON data.
 ///
-/// @param clusterManagersToAdd List of clustermanager object data.
+/// @param clusterManagersToAdd Array of cluster managers JSON data to add.
 - (void)addJSONClusterManagers:(NSArray<NSDictionary *> *)clusterManagersToAdd;
 
-/// Creates ClusterManagers and initializes them.
+/// Creates cluster managers and initializes them.
 ///
-/// @param clusterManagersToAdd List of clustermanager object data.
+/// @param clusterManagersToAdd Array of cluster managers to add.
 - (void)addClusterManagers:(NSArray<FGMPlatformClusterManager *> *)clusterManagersToAdd;
 
-/// Removes requested ClusterManagers from the controller.
+/// Removes requested cluster managers from the controller.
 ///
-/// @param identifiers List of clusterManagerIds to remove.
-
+/// @param identifiers Array of cluster manager IDs to remove.
 - (void)removeClusterManagersWithIdentifiers:(NSArray<NSString *> *)identifiers;
 
-/// Returns the ClusterManager for the given identifier.
+/// Returns the cluster managers for the given identifier.
 ///
-/// @param identifier identifier of the ClusterManager.
-/// @return GMUClusterManager if found; otherwise, nil.
+/// @param identifier The identifier of the cluster manager.
+/// @return A cluster manager if found; otherwise, nil.
 - (nullable GMUClusterManager *)clusterManagerWithIdentifier:(NSString *)identifier;
 
-/// Converts clusters managed by the specified ClusterManager to
-/// a serializable array of clusters.
-///
-/// This method fetches and serializes clusters at the current zoom
-/// level from the ClusterManager identified by the given identifier.
-/// If the specified ClusterManager identifier does not exist, an empty
-/// array is returned.
+/// Returns an array of clusters managed by the cluster manager.
 ///
-/// @param identifier The identifier of the ClusterManager to serialize.
-/// @return An array of FGMPlatformCluster objects representing the clusters. `nil` is returned only
-/// when `error != nil`.
+/// @param identifier The identifier of the cluster manager whose clusters are to be retrieved.
+/// @return An array of clusters. Returns `nil` only if `error` is populated.
 - (nullable NSArray<FGMPlatformCluster *> *)
     clustersWithIdentifier:(NSString *)identifier
                      error:(FlutterError *_Nullable __autoreleasing *_Nonnull)error;
 
-/// Called when cluster marker is tapped on the map.
+/// Called when a cluster marker is tapped on the map.
 ///
-/// @param cluster GMUStaticCluster object.
+/// @param cluster The cluster that was tapped on.
 - (void)didTapCluster:(GMUStaticCluster *)cluster;
 
-/// Calls cluster method of all ClusterManagers.
+/// Calls the cluster method of all the cluster managers.
 - (void)invokeClusteringForEachClusterManager;
 @end
 

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FGMClusterManagersController.m

@@ -9,14 +9,14 @@
 
 @interface FGMClusterManagersController ()
 
-/// A dictionary that cluster managers unique identifiers to GMUClusterManager instances.
+/// A dictionary mapping unique cluster manager identifiers to their corresponding cluster managers.
 @property(strong, nonatomic)
     NSMutableDictionary<NSString *, GMUClusterManager *> *clusterManagerIdentifierToManagers;
 
 /// The callback handler interface for calls to Flutter.
 @property(strong, nonatomic) FGMMapsCallbackApi *callbackHandler;
 
-/// The current GMSMapView instance on which the cluster managers are operating.
+/// The current map instance on which the cluster managers are operating.
 @property(strong, nonatomic) GMSMapView *mapView;
 
 @end
@@ -53,10 +53,9 @@ - (void)addClusterManager:(NSString *)identifier {
   id<GMUClusterRenderer> renderer =
       [[GMUDefaultClusterRenderer alloc] initWithMapView:self.mapView
                                     clusterIconGenerator:iconGenerator];
-  GMUClusterManager *clusterManager = [[GMUClusterManager alloc] initWithMap:self.mapView
-                                                                   algorithm:algorithm
-                                                                    renderer:renderer];
-  self.clusterManagerIdentifierToManagers[identifier] = clusterManager;
+  self.clusterManagerIdentifierToManagers[identifier] =
+      [[GMUClusterManager alloc] initWithMap:self.mapView algorithm:algorithm renderer:renderer];
+  ;
 }
 
 - (void)removeClusterManagersWithIdentifiers:(NSArray<NSString *> *)identifiers {
@@ -121,10 +120,9 @@ - (void)didTapCluster:(GMUStaticCluster *)cluster {
 
 #pragma mark - Private methods
 
-/// Returns the cluster manager id for given cluster.
+/// Returns the cluster manager identifier for given cluster.
 ///
-/// @param cluster identifier of the ClusterManager.
-/// @return id NSString if found; otherwise, nil.
+/// @return The cluster manager identifier if found; otherwise, nil.
 - (nullable NSString *)clusterManagerIdentifierForCluster:(GMUStaticCluster *)cluster {
   if ([cluster.items.firstObject isKindOfClass:[GMSMarker class]]) {
     GMSMarker *firstMarker = (GMSMarker *)cluster.items.firstObject;

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FGMMarkerUserData.h

@@ -18,25 +18,20 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
-/// Sets MarkerId and optionally ClusterManagerId to GMSMarker UserData.
-///
-/// @param markerIdentifier Identifier of marker.
-/// @param clusterManagerIdentifier Optional identifier of cluster manager.
-/// @param marker GMSMarker object.
+/// Associates a marker identifier and optionally a cluster manager identifier with a marker's user
+/// data.
 extern void FGMSetIdentifiersToMarkerUserData(NSString *markerIdentifier,
                                               NSString *_Nullable clusterManagerIdentifier,
                                               GMSMarker *marker);
 
-/// Get MarkerIdentifier from GMSMarker UserData.
+/// Get the marker identifier from marker's user data.
 ///
-/// @param marker GMSMarker object.
-/// @return NSString if found; otherwise, nil.
+/// @return The marker identifier if found; otherwise, nil.
 extern NSString *_Nullable FGMGetMarkerIdentifierFromMarker(GMSMarker *marker);
 
-/// Get ClusterManagerIdentifier from GMSMarker UserData.
+/// Get the cluster manager identifier from marker's user data.
 ///
-/// @param marker GMSMarker object.
-/// @return NSString if found; otherwise, nil.
+/// @return The cluster manager identifier if found; otherwise, nil.
 extern NSString *_Nullable FGMGetClusterManagerIdentifierFromMarker(GMSMarker *marker);
 
 NS_ASSUME_NONNULL_END

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/FLTGoogleMapsPlugin.h

@@ -4,6 +4,7 @@
 
 #import <Flutter/Flutter.h>
 #import <GoogleMaps/GoogleMaps.h>
+
 #import "FGMClusterManagersController.h"
 #import "GoogleMapCircleController.h"
 #import "GoogleMapController.h"

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/GoogleMapController.h

@@ -2,13 +2,15 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <GoogleMaps/GoogleMaps.h>
 #import "FGMClusterManagersController.h"
 #import "GoogleMapCircleController.h"
 #import "GoogleMapMarkerController.h"
 #import "GoogleMapPolygonController.h"
 #import "GoogleMapPolylineController.h"
+
+#import <Flutter/Flutter.h>
+#import <GoogleMaps/GoogleMaps.h>
+
 #import "messages.g.h"
 
 NS_ASSUME_NONNULL_BEGIN

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/GoogleMapMarkerController.h

@@ -2,10 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-#import <Flutter/Flutter.h>
-#import <GoogleMaps/GoogleMaps.h>
 #import "FGMClusterManagersController.h"
 #import "GoogleMapController.h"
+
+#import <Flutter/Flutter.h>
+#import <GoogleMaps/GoogleMaps.h>
+
 #import "messages.g.h"
 
 NS_ASSUME_NONNULL_BEGIN

packages/google_maps_flutter/google_maps_flutter_ios/ios/Classes/GoogleMapMarkerController.m

@@ -3,6 +3,7 @@
 // found in the LICENSE file.
 
 #import "GoogleMapMarkerController.h"
+
 #import "FGMMarkerUserData.h"
 #import "FLTGoogleMapJSONConversions.h"