From e8aab02827af81a63f69924839e550909f444323 Mon Sep 17 00:00:00 2001
From: Colleen McGinnis <colleen.mcginnis@mapbox.com>
Date: Mon, 20 Apr 2020 15:57:45 -0700
Subject: [PATCH] [docsprint] Add example to MapMouseEvent (#9595)

* add example to MapMouseEvent

* fix linting error

* fix copy paste error
---
 src/ui/events.js | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/src/ui/events.js b/src/ui/events.js
index c987b1b3e55..4a793f603b4 100644
--- a/src/ui/events.js
+++ b/src/ui/events.js
@@ -12,10 +12,27 @@ import type LngLat from '../geo/lng_lat';
 /**
  * `MapMouseEvent` is the event type for mouse-related map events.
  * @extends {Object}
+ * @example
+ * // The `click` event is an example of a `MapMouseEvent`.
+ * // Set up an event listener on the map.
+ * map.on('click', function(e) {
+ *   // The event object (`e`) contains information like the
+ *   // coordinates of the point on the map that was clicked.
+ *   console.log('A click event has occurred at ' + e.lngLat);
+ * });
  */
 export class MapMouseEvent extends Event {
     /**
-     * The event type.
+     * The event type (one of [`mousedown`](#map.event:mousedown),
+     * [`mouseup`](#map.event:mouseup),
+     * [`click`](#map.event:click),
+     * [`dblclick`](#map.event:dblclick),
+     * [`mousemove`](#map.event:mousemove),
+     * [`mouseover`](#map.event:mouseover),
+     * [`mouseenter`](#map.event:mouseenter),
+     * [`mouseleave`](#map.event:mouseleave),
+     * [`mouseout`](#map.event:mouseout),
+     * [`contextmenu`](#map.event:contextmenu)).
      */
     type: 'mousedown'
         | 'mouseup'