Skip to content

Commit b9d42a6

Browse files
aditya-cherukuriNyholm
authored andcommitted
improving docs for GoogleMaps model (#738)
* improving docs for GoogleMaps model * applying style CI fixes for Google Maps provider
1 parent 5325fd4 commit b9d42a6

File tree

1 file changed

+42
-14
lines changed

1 file changed

+42
-14
lines changed

src/Provider/GoogleMaps/Model/GoogleAddress.php

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,9 @@ public function getFormattedAddress()
150150
}
151151

152152
/**
153-
* @param null|string $formattedAddress
153+
* @param string|null $formattedAddress
154+
*
155+
* @return GoogleAddress
154156
*/
155157
public function withFormattedAddress(string $formattedAddress = null)
156158
{
@@ -169,7 +171,9 @@ public function getAirport()
169171
}
170172

171173
/**
172-
* @param null|string $airport
174+
* @param string|null $airport
175+
*
176+
* @return GoogleAddress
173177
*/
174178
public function withAirport(string $airport = null)
175179
{
@@ -188,7 +192,9 @@ public function getColloquialArea()
188192
}
189193

190194
/**
191-
* @param null|string $colloquialArea
195+
* @param string|null $colloquialArea
196+
*
197+
* @return GoogleAddress
192198
*/
193199
public function withColloquialArea(string $colloquialArea = null)
194200
{
@@ -207,7 +213,9 @@ public function getIntersection()
207213
}
208214

209215
/**
210-
* @param null|string $intersection
216+
* @param string|null $intersection
217+
*
218+
* @return GoogleAddress
211219
*/
212220
public function withIntersection(string $intersection = null)
213221
{
@@ -226,7 +234,9 @@ public function getNaturalFeature()
226234
}
227235

228236
/**
229-
* @param null|string $naturalFeature
237+
* @param string|null $naturalFeature
238+
*
239+
* @return GoogleAddress
230240
*/
231241
public function withNaturalFeature(string $naturalFeature = null)
232242
{
@@ -245,7 +255,9 @@ public function getNeighborhood()
245255
}
246256

247257
/**
248-
* @param null|string $neighborhood
258+
* @param string|null $neighborhood
259+
*
260+
* @return GoogleAddress
249261
*/
250262
public function withNeighborhood(string $neighborhood = null)
251263
{
@@ -264,7 +276,9 @@ public function getPark()
264276
}
265277

266278
/**
267-
* @param null|string $park
279+
* @param string|null $park
280+
*
281+
* @return GoogleAddress
268282
*/
269283
public function withPark(string $park = null)
270284
{
@@ -283,7 +297,9 @@ public function getPointOfInterest()
283297
}
284298

285299
/**
286-
* @param null|string $pointOfInterest
300+
* @param string|null $pointOfInterest
301+
*
302+
* @return GoogleAddress
287303
*/
288304
public function withPointOfInterest(string $pointOfInterest = null)
289305
{
@@ -302,7 +318,9 @@ public function getPolitical()
302318
}
303319

304320
/**
305-
* @param null|string $political
321+
* @param string|null $political
322+
*
323+
* @return GoogleAddress
306324
*/
307325
public function withPolitical(string $political = null)
308326
{
@@ -321,7 +339,9 @@ public function getPremise()
321339
}
322340

323341
/**
324-
* @param null|string $premise
342+
* @param null $premise
343+
*
344+
* @return GoogleAddress
325345
*/
326346
public function withPremise($premise = null)
327347
{
@@ -340,7 +360,9 @@ public function getStreetAddress()
340360
}
341361

342362
/**
343-
* @param null|string $streetAddress
363+
* @param string|null $streetAddress
364+
*
365+
* @return GoogleAddress
344366
*/
345367
public function withStreetAddress(string $streetAddress = null)
346368
{
@@ -359,7 +381,9 @@ public function getSubpremise()
359381
}
360382

361383
/**
362-
* @param null|string $subpremise
384+
* @param string|null $subpremise
385+
*
386+
* @return GoogleAddress
363387
*/
364388
public function withSubpremise(string $subpremise = null)
365389
{
@@ -378,7 +402,9 @@ public function getWard()
378402
}
379403

380404
/**
381-
* @param null|string $ward
405+
* @param string|null $ward
406+
*
407+
* @return GoogleAddress
382408
*/
383409
public function withWard(string $ward = null)
384410
{
@@ -397,7 +423,9 @@ public function getEstablishment()
397423
}
398424

399425
/**
400-
* @param null|string $ward
426+
* @param string|null $establishment
427+
*
428+
* @return GoogleAddress
401429
*/
402430
public function withEstablishment(string $establishment = null)
403431
{

0 commit comments

Comments
 (0)