Tweaking documentation for SVGOverlay, add links to the docs index. (L…

…eaflet#6631)
Schleuse · Dec 3, 2019 · 673d88c · 673d88c
1 parent 7c715e8
commit 673d88c
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/build/docs-index.leafdoc b/build/docs-index.leafdoc
@@ -13,6 +13,7 @@ This file just defines the order of the classes in the docs.
 @class TileLayer.WMS
 @class ImageOverlay
 @class VideoOverlay
+@class SVGOverlay
 
 @class Path
 @class Polyline

diff --git a/build/leafdoc-templates/html.hbs b/build/leafdoc-templates/html.hbs
@@ -60,6 +60,7 @@
 				<li><a href="#rectangle">Rectangle</a></li>
 				<li><a href="#circle">Circle</a></li>
 				<li><a href="#circlemarker">CircleMarker</a></li>
+				<li><a href="#svgoverlay">SVGOverlay</a></li>
 				<li><a href="#svg">SVG</a></li>
 				<li><a href="#canvas">Canvas</a></li>
 			</ul>

diff --git a/src/layer/SVGOverlay.js b/src/layer/SVGOverlay.js
@@ -9,12 +9,12 @@ import * as Util from '../core/Util';
  *
  * Used to load, display and provide DOM access to an SVG file over specific bounds of the map. Extends `ImageOverlay`.
  *
- * An SVG overlay uses the [`<svg>`](https://developer.mozilla.org/docs/Web/SVG/Element/svg) element
+ * An SVG overlay uses the [`<svg>`](https://developer.mozilla.org/docs/Web/SVG/Element/svg) element.
  *
  * @example
  *
  * ```js
- * var element = '<svg width="200" height="200" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><image xlink:href="https://mdn.mozillademos.org/files/6457/mdn_logo_only_color.png" height="200" width="200"/></svg>,
+ * var element = '<svg width="200" height="200" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><image xlink:href="https://mdn.mozillademos.org/files/6457/mdn_logo_only_color.png" height="200" width="200"/></svg>',
  * 		 elementBounds = [ [ 32, -130 ], [ 13, -100 ] ];
  * L.svgOverlay(element, elementBounds).addTo(map);
  * ```