Skip to content

Commit 3b5fd5d

Browse files
GitToTheHubGitToTheHub
committed
iOS: Update parameter descriptions to fix warnings with cordova-ios 8.0.0
- @params often declared a wrong parameter - Document the content of the command parameter
1 parent e19efc7 commit 3b5fd5d

File tree

7 files changed

+71
-72
lines changed

7 files changed

+71
-72
lines changed

‎src/ios/GoogleMaps/PluginCircle.m‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ -(void)create:(CDVInvokedUrlCommand *)command
140140
}
141141
/**
142142
* Set center
143-
* @params key
143+
* @params command First Argument is circle ID, Second is latitude, Third is longitude
144144
*/
145145
-(void)setCenter:(CDVInvokedUrlCommand *)command
146146
{
@@ -164,7 +164,7 @@ -(void)setCenter:(CDVInvokedUrlCommand *)command
164164

165165
/**
166166
* Set fill color
167-
* @params key
167+
* @params command First Argument is circle ID, Second is RGB color array
168168
*/
169169
-(void)setFillColor:(CDVInvokedUrlCommand *)command
170170
{
@@ -185,7 +185,7 @@ -(void)setFillColor:(CDVInvokedUrlCommand *)command
185185

186186
/**
187187
* Set stroke color
188-
* @params key
188+
* @params command First Argument is circle ID, Second is RGB color array
189189
*/
190190
-(void)setStrokeColor:(CDVInvokedUrlCommand *)command
191191
{
@@ -205,7 +205,7 @@ -(void)setStrokeColor:(CDVInvokedUrlCommand *)command
205205

206206
/**
207207
* Set stroke width
208-
* @params key
208+
* @params command First Argument is circle ID, Second is stroke width
209209
*/
210210
-(void)setStrokeWidth:(CDVInvokedUrlCommand *)command
211211
{
@@ -225,7 +225,7 @@ -(void)setStrokeWidth:(CDVInvokedUrlCommand *)command
225225

226226
/**
227227
* Set radius
228-
* @params key
228+
* @params command First Argument is circle ID, Second is radius
229229
*/
230230
-(void)setRadius:(CDVInvokedUrlCommand *)command
231231
{
@@ -243,7 +243,7 @@ -(void)setRadius:(CDVInvokedUrlCommand *)command
243243
}
244244
/**
245245
* Set z-index
246-
* @params key
246+
* @params command First Argument is circle ID, Second is z-index
247247
*/
248248
-(void)setZIndex:(CDVInvokedUrlCommand *)command
249249
{
@@ -262,7 +262,7 @@ -(void)setZIndex:(CDVInvokedUrlCommand *)command
262262

263263
/**
264264
* Set visibility
265-
* @params key
265+
* @params command First Argument is circle ID, Second is visibility
266266
*/
267267
-(void)setVisible:(CDVInvokedUrlCommand *)command
268268
{
@@ -297,7 +297,7 @@ -(void)setVisible:(CDVInvokedUrlCommand *)command
297297

298298
/**
299299
* Set clickable
300-
* @params key
300+
* @params command First Argument is circle ID, Second is clickable
301301
*/
302302
-(void)setClickable:(CDVInvokedUrlCommand *)command
303303
{
@@ -321,7 +321,7 @@ -(void)setClickable:(CDVInvokedUrlCommand *)command
321321

322322
/**
323323
* Remove the circle
324-
* @params key
324+
* @params command First Argument is circle ID
325325
*/
326326
-(void)remove:(CDVInvokedUrlCommand *)command
327327
{

‎src/ios/GoogleMaps/PluginGroundOverlay.m‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ - (void)_setImage:(GMSGroundOverlay *)groundOverlay urlStr:(NSString *)urlStr co
305305

306306
/**
307307
* Remove the ground overlay
308-
* @params key
308+
* @params command First Argument is ground overlay ID
309309
*/
310310
-(void)remove:(CDVInvokedUrlCommand *)command
311311
{
@@ -331,7 +331,7 @@ -(void)remove:(CDVInvokedUrlCommand *)command
331331

332332
/**
333333
* Set visibility
334-
* @params key
334+
* @params command First Argument is ground overlay ID, Second is visibility
335335
*/
336336
-(void)setVisible:(CDVInvokedUrlCommand *)command
337337
{
@@ -365,7 +365,7 @@ -(void)setVisible:(CDVInvokedUrlCommand *)command
365365

366366
/**
367367
* set image
368-
* @params key
368+
* @params command First Argument is ground overlay ID, Second is image URL
369369
*/
370370
-(void)setImage:(CDVInvokedUrlCommand *)command
371371
{
@@ -399,7 +399,7 @@ -(void)setImage:(CDVInvokedUrlCommand *)command
399399

400400
/**
401401
* Set bounds
402-
* @params key
402+
* @params command First Argument is ground overlay ID, Second is bounds
403403
*/
404404
-(void)setBounds:(CDVInvokedUrlCommand *)command
405405
{
@@ -429,7 +429,7 @@ -(void)setBounds:(CDVInvokedUrlCommand *)command
429429

430430
/**
431431
* Set opacity
432-
* @params key
432+
* @params command First Argument is ground overlay ID, Second is opacity
433433
*/
434434
-(void)setOpacity:(CDVInvokedUrlCommand *)command
435435
{
@@ -450,7 +450,7 @@ -(void)setOpacity:(CDVInvokedUrlCommand *)command
450450

451451
/**
452452
* Set bearing
453-
* @params key
453+
* @params command First Argument is ground overlay ID, Second is bearing
454454
*/
455455
-(void)setBearing:(CDVInvokedUrlCommand *)command
456456
{
@@ -471,7 +471,7 @@ -(void)setBearing:(CDVInvokedUrlCommand *)command
471471

472472
/**
473473
* Set clickable
474-
* @params key
474+
* @params command First Argument is ground overlay ID, Second is clickable
475475
*/
476476
-(void)setClickable:(CDVInvokedUrlCommand *)command
477477
{
@@ -495,7 +495,7 @@ -(void)setClickable:(CDVInvokedUrlCommand *)command
495495

496496
/**
497497
* Set z-index
498-
* @params key
498+
* @params command First Argument is ground overlay ID, Second is z-index
499499
*/
500500
-(void)setZIndex:(CDVInvokedUrlCommand *)command
501501
{

‎src/ios/GoogleMaps/PluginMapViewController.m‎

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,6 @@ - (void)mapView:(GMSMapView *)mapView didTapMyLocation:(CLLocationCoordinate2D)l
6464
[self execJS:jsString];
6565
}
6666

67-
/**
68-
* @callback the my location button is clicked.
69-
*/
7067
- (void)mapView:(GMSMapView *)mapView didTapAtCoordinate:(CLLocationCoordinate2D)coordinate {
7168

7269

@@ -271,14 +268,14 @@ - (void)mapView:(GMSMapView *)mapView didTapAtCoordinate:(CLLocationCoordinate2D
271268

272269
}
273270
/**
274-
* @callback map long_click
271+
* map_long_click
275272
*/
276273
- (void) mapView:(GMSMapView *)mapView didLongPressAtCoordinate:(CLLocationCoordinate2D)coordinate {
277274
[self triggerMapEvent:@"map_long_click" coordinate:coordinate];
278275
}
279276

280277
/**
281-
* @callback plugin.google.maps.event.CAMERA_MOVE_START
278+
* plugin.google.maps.event.CAMERA_MOVE_START
282279
*/
283280
- (void) mapView:(GMSMapView *)mapView willMove:(BOOL)gesture
284281
{
@@ -292,7 +289,7 @@ - (void) mapView:(GMSMapView *)mapView willMove:(BOOL)gesture
292289

293290

294291
/**
295-
* @callback plugin.google.maps.event.CAMERA_MOVE
292+
* plugin.google.maps.event.CAMERA_MOVE
296293
*/
297294
- (void)mapView:(GMSMapView *)mapView didChangeCameraPosition:(GMSCameraPosition *)position {
298295

@@ -303,7 +300,7 @@ - (void)mapView:(GMSMapView *)mapView didChangeCameraPosition:(GMSCameraPosition
303300
}
304301

305302
/**
306-
* @callback plugin.google.maps.event.CAMERA_MOVE_END
303+
* plugin.google.maps.event.CAMERA_MOVE_END
307304
*/
308305
- (void) mapView:(GMSMapView *)mapView idleAtCameraPosition:(GMSCameraPosition *)position
309306
{
@@ -316,7 +313,7 @@ - (void) mapView:(GMSMapView *)mapView idleAtCameraPosition:(GMSCameraPosition *
316313

317314

318315
/**
319-
* @callback marker info_click
316+
* marker info_click
320317
*/
321318
- (void) mapView:(GMSMapView *)mapView didTapInfoWindowOfMarker:(GMSMarker *)marker
322319
{
@@ -342,7 +339,7 @@ - (void)mapView:(GMSMapView *)mapView didLongPressInfoWindowOfMarker:(GMSMarker
342339
}
343340
}
344341
/**
345-
* @callback plugin.google.maps.event.MARKER_DRAG_START
342+
* plugin.google.maps.event.MARKER_DRAG_START
346343
*/
347344
- (void) mapView:(GMSMapView *) mapView didBeginDraggingMarker:(GMSMarker *)marker
348345
{
@@ -355,7 +352,7 @@ - (void) mapView:(GMSMapView *) mapView didBeginDraggingMarker:(GMSMarker *)mark
355352
}
356353
}
357354
/**
358-
* @callback plugin.google.maps.event.MARKER_DRAG_END
355+
* plugin.google.maps.event.MARKER_DRAG_END
359356
*/
360357
- (void) mapView:(GMSMapView *) mapView didEndDraggingMarker:(GMSMarker *)marker
361358
{
@@ -368,7 +365,7 @@ - (void) mapView:(GMSMapView *) mapView didEndDraggingMarker:(GMSMarker *)marker
368365
}
369366
}
370367
/**
371-
* @callback plugin.google.maps.event.MARKER_DRAG
368+
* plugin.google.maps.event.MARKER_DRAG
372369
*/
373370
- (void) mapView:(GMSMapView *) mapView didDragMarker:(GMSMarker *)marker
374371
{
@@ -396,7 +393,7 @@ - (void) syncInfoWndPosition {
396393
}
397394

398395
/**
399-
* @callback plugin.google.maps.event.MARKER_CLICK
396+
* plugin.google.maps.event.MARKER_CLICK
400397
*/
401398
- (BOOL)mapView:(GMSMapView *)mapView didTapMarker:(GMSMarker *)marker {
402399

0 commit comments

Comments
 (0)