Merge pull request #392 from tlaverdure/docs(google-maps)

docs(google maps) - Updates to Google Maps docs

src/plugins/googlemaps.ts

@@ -51,7 +51,9 @@ export const GoogleMapsAnimation = {
  * ...
  *
  * // somewhere in your component
- * let map = new GoogleMap('elementID');
+ * let map = new GoogleMap('elementID', {
+ *  // Map Options: https://developers.google.com/maps/documentation/javascript/3.exp/reference#MapOptions
+ });
  *
  * map.on(GoogleMapsEvent.MAP_READY).subscribe(() => console.log('Map is ready!'));
  * ```
@@ -65,8 +67,9 @@ export class GoogleMap {
   _objectInstance: any;
 
   /**
-   * Checks if a map object has been created.
-   * @return {Promise<boolean>} returns a promise that resolves with a boolean that indicates if the plugin is available.
+   * Checks if a map object has been created and is available.
+   * 
+   * @return {Promise<boolean>}
    */
   @Cordova()
   static isAvailable(): Promise<boolean> {
@@ -76,7 +79,12 @@ export class GoogleMap {
   constructor(elementId: string, options?: any) {
     this._objectInstance = plugin.google.maps.Map.getMap(document.getElementById(elementId), options);
   }
-
+  
+  /**
+   * Listen to a map event.
+   * 
+   * @return {Observable<any>}
+   */
   on(event: any): Observable<any> {
     return new Observable(
       (observer) => {
@@ -85,14 +93,18 @@ export class GoogleMap {
       }
     );
   }
-
+  
+  /** 
+   * Listen to a map event only once.
+   * 
+   * @return {Promise<any>}
+   */
   one(event: any): Promise<any> {
     return new Promise<any>(
       resolve => this._objectInstance.one(event, resolve)
     );
   }
 
-
   @CordovaInstance({ sync: true })
   setDebuggable(isDebuggable: boolean): void {
   }
@@ -102,7 +114,9 @@ export class GoogleMap {
   }
 
   /**
-   * Get the position of the camera
+   * Get the position of the camera.
+   * 
+   * @return {Promise<CameraPosition>}
    */
   @CordovaInstance()
   getCameraPosition(): Promise<CameraPosition> {
@@ -110,7 +124,9 @@ export class GoogleMap {
   }
 
   /**
-   * Get the location of the user
+   * Get the location of the user.
+   * 
+   * @return {Promise<MyLocation>}
    */
   @CordovaInstance()
   getMyLocation(): Promise<MyLocation> {
@@ -118,7 +134,9 @@ export class GoogleMap {
   }
 
   /**
-   * Get the visible region
+   * Get the visible region.
+   * 
+   * @return {Promise<VisibleRegion>}
    */
   @CordovaInstance()
   getVisibleRegion(): Promise<VisibleRegion> {