search

yidas / google-maps-services-php

PHP client library (SDK) for Google Maps API Web Services
https://yidas.github.io/google-maps-services-php/
MIT License
70 stars 34 forks source link

Add PHPDocs for various methods on Client class #6

Closed omacranger closed 3 years ago

omacranger commented 3 years ago

It would be great if we could have PHPDocs for the various methods on the client class - which could provide some code completion for the likes of PHPStorm / intellisense.

Something like below on the Client class would be pretty beneficial: 

/**
 * Google Maps PHP Client
 *
 * @author  Nick Tsai <myintaer@gmail.com>
 * @version 1.0.0
 *
 * @method array distanceMatrix(string $origin, string $destination, array $params = [])
 ...
 */
class Client

I don't mind putting together a PR for this either.

omacranger commented 3 years ago

Actually, looks like this would be closed by #2

yidas commented 3 years ago

Hi @omacranger,

Thank you for you advice!

Please take the version 1.0.2.

omacranger commented 3 years ago

Hey @yidas, appreciate it. Though it looks like the PHPDocs you have there aren't quite accurate. The first $client parameter you're passing automatically here - so that should be removed from all the PHPDocs since users wouldn't be expected to pass that manually.

yidas commented 3 years ago

Hi @omacranger,

I really appreciate your help!

Please take the version 1.0.3.