From 77a88b5526dbd3fd43d0de4e92b08d892c0c04d6 Mon Sep 17 00:00:00 2001 From: Jon West Date: Mon, 7 Nov 2016 19:57:02 -0600 Subject: [PATCH] Cleaning documentation in prep for release --- CHANGELOG.md | 19 ++ build/docs-index.leafdoc | 8 +- build/leafdoc-templates/html.hbs | 22 +-- docs/leaflet-draw-0.4.2.html | 302 +++++++++++++++---------------- docs/leaflet-draw-latest.html | 302 +++++++++++++++---------------- src/ext/LineUtil.Intersect.js | 4 +- 6 files changed, 334 insertions(+), 323 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index af98d0c44..dabb0f8ad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,25 @@ Leaflet.draw Changelog An in-progress version being developed on the master branch. +## 0.4.2 (November 7, 2016) + +### Improvements + + * Documentation is now automatically generated + * L.Draw.Event is new, has all events in string format + +### Bugfixes + + * Travis tests + +## 0.4.1 (October 21, 2016) + +### Bugfixes + + * fix markers becomming invisible when in edit mode + * Fix linking for EditPolyOptions + * Fixes very minor issue in readme with invalid variable name + ## 0.4.0 (October 13, 2016) ### Improvements diff --git a/build/docs-index.leafdoc b/build/docs-index.leafdoc index 658bcdd52..da4c010e7 100644 --- a/build/docs-index.leafdoc +++ b/build/docs-index.leafdoc @@ -23,7 +23,7 @@ This file just defines the order of the classes in the docs. @class L.GeometryUtil @class L.LatLngUtil -@class L.LineUtil.Intersect -@class L.Polygon.Intersect -@class L.Polyline.Intersect -@class L.TouchEvents +@class L.LineUtil +@class L.Polygon +@class L.Polyline +@class L.Map.TouchExtend diff --git a/build/leafdoc-templates/html.hbs b/build/leafdoc-templates/html.hbs index 2fc67c100..25902152e 100644 --- a/build/leafdoc-templates/html.hbs +++ b/build/leafdoc-templates/html.hbs @@ -32,7 +32,7 @@

Controls

Examples

diff --git a/docs/leaflet-draw-0.4.2.html b/docs/leaflet-draw-0.4.2.html index c120ab5b7..c8d50c82c 100644 --- a/docs/leaflet-draw-0.4.2.html +++ b/docs/leaflet-draw-0.4.2.html @@ -32,7 +32,7 @@

Draw

Controls

Examples

@@ -1336,11 +1336,144 @@

Methods

-

L.LineUtil.Intersect

-

L.Polygon.Intersect

-

L.Polyline.Intersect

-

L.TouchEvents

-

L.Control.Draw

+

L.LineUtil

+
+

Methods

+ +
+ + + + + + + + + + + + + + + + +
MethodReturnsDescription
segmentsIntersect()void

Checks to see if two line segments intersect. Does not handle degenerate cases. +http://compgeom.cs.uiuc.edu/~jeffe/teaching/373/notes/x06-sweepline.pdf

+
+ +
+ + +

L.Polygon

+
+

Methods

+ +
+ + + + + + + + + + + + + + + + +
MethodReturnsDescription
intersects()void

Checks a polygon for any intersecting line segments. Ignores holes.

+
+ +
+ + +

L.Polyline

+
+

Methods

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodReturnsDescription
intersects()void

Check to see if this polyline has any linesegments that intersect. +NOTE: does not support detecting intersection for degenerate cases.

+
newLatLngIntersects()void

Check for intersection if new latlng was added to this polyline. +NOTE: does not support detecting intersection for degenerate cases.

+
newPointIntersects()void

Check for intersection if new point was added to this polyline. +newPoint must be a layer point. +NOTE: does not support detecting intersection for degenerate cases.

+
+ +
+ + +

L.Map.TouchExtend

+
+

Methods

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodReturnsDescription
initialize()void

Sets TouchExtend private accessor variables

+
addHooks()void

Adds dom listener events to the map container

+
removeHooks()void

Removes dom listener events from the map container

+
+ +
+ + +

L.Control.Draw

Methods

@@ -1594,143 +1727,6 @@

Methods

-

L.Util

-
-

Methods

- -
- - - - - - - - - - - - - - - - -
MethodReturnsDescription
segmentsIntersect()void

Checks to see if two line segments intersect. Does not handle degenerate cases. -http://compgeom.cs.uiuc.edu/~jeffe/teaching/373/notes/x06-sweepline.pdf

-
- -
- - -

L.Polygon

-
-

Methods

- -
- - - - - - - - - - - - - - - - -
MethodReturnsDescription
intersects()void

Checks a polygon for any intersecting line segments. Ignores holes.

-
- -
- - -

L.Polyline

-
-

Methods

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
MethodReturnsDescription
intersects()void

Check to see if this polyline has any linesegments that intersect. -NOTE: does not support detecting intersection for degenerate cases.

-
newLatLngIntersects()void

Check for intersection if new latlng was added to this polyline. -NOTE: does not support detecting intersection for degenerate cases.

-
newPointIntersects()void

Check for intersection if new point was added to this polyline. -newPoint must be a layer point. -NOTE: does not support detecting intersection for degenerate cases.

-
- -
- - -

L.Map.TouchExtend

-
-

Methods

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
MethodReturnsDescription
initialize()void

Sets TouchExtend private accessor variables

-
addHooks()void

Adds dom listener events to the map container

-
removeHooks()void

Removes dom listener events from the map container

-
- -
- -

L.Marker.Touch

This isn't full Touch support. This is just to get makers to also support dom touch events after creation

#TODO: find a better way of getting markers to support touch.

diff --git a/docs/leaflet-draw-latest.html b/docs/leaflet-draw-latest.html index c120ab5b7..c8d50c82c 100644 --- a/docs/leaflet-draw-latest.html +++ b/docs/leaflet-draw-latest.html @@ -32,7 +32,7 @@

Draw

Controls

Examples

@@ -1336,11 +1336,144 @@

Methods

-

L.LineUtil.Intersect

-

L.Polygon.Intersect

-

L.Polyline.Intersect

-

L.TouchEvents

-

L.Control.Draw

+

L.LineUtil

+
+

Methods

+ +
+ + + + + + + + + + + + + + + + +
MethodReturnsDescription
segmentsIntersect()void

Checks to see if two line segments intersect. Does not handle degenerate cases. +http://compgeom.cs.uiuc.edu/~jeffe/teaching/373/notes/x06-sweepline.pdf

+
+ +
+ + +

L.Polygon

+
+

Methods

+ +
+ + + + + + + + + + + + + + + + +
MethodReturnsDescription
intersects()void

Checks a polygon for any intersecting line segments. Ignores holes.

+
+ +
+ + +

L.Polyline

+
+

Methods

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodReturnsDescription
intersects()void

Check to see if this polyline has any linesegments that intersect. +NOTE: does not support detecting intersection for degenerate cases.

+
newLatLngIntersects()void

Check for intersection if new latlng was added to this polyline. +NOTE: does not support detecting intersection for degenerate cases.

+
newPointIntersects()void

Check for intersection if new point was added to this polyline. +newPoint must be a layer point. +NOTE: does not support detecting intersection for degenerate cases.

+
+ +
+ + +

L.Map.TouchExtend

+
+

Methods

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
MethodReturnsDescription
initialize()void

Sets TouchExtend private accessor variables

+
addHooks()void

Adds dom listener events to the map container

+
removeHooks()void

Removes dom listener events from the map container

+
+ +
+ + +

L.Control.Draw

Methods

@@ -1594,143 +1727,6 @@

Methods

-

L.Util

-
-

Methods

- -
- - - - - - - - - - - - - - - - -
MethodReturnsDescription
segmentsIntersect()void

Checks to see if two line segments intersect. Does not handle degenerate cases. -http://compgeom.cs.uiuc.edu/~jeffe/teaching/373/notes/x06-sweepline.pdf

-
- -
- - -

L.Polygon

-
-

Methods

- -
- - - - - - - - - - - - - - - - -
MethodReturnsDescription
intersects()void

Checks a polygon for any intersecting line segments. Ignores holes.

-
- -
- - -

L.Polyline

-
-

Methods

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
MethodReturnsDescription
intersects()void

Check to see if this polyline has any linesegments that intersect. -NOTE: does not support detecting intersection for degenerate cases.

-
newLatLngIntersects()void

Check for intersection if new latlng was added to this polyline. -NOTE: does not support detecting intersection for degenerate cases.

-
newPointIntersects()void

Check for intersection if new point was added to this polyline. -newPoint must be a layer point. -NOTE: does not support detecting intersection for degenerate cases.

-
- -
- - -

L.Map.TouchExtend

-
-

Methods

- -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
MethodReturnsDescription
initialize()void

Sets TouchExtend private accessor variables

-
addHooks()void

Adds dom listener events to the map container

-
removeHooks()void

Removes dom listener events from the map container

-
- -
- -

L.Marker.Touch

This isn't full Touch support. This is just to get makers to also support dom touch events after creation

#TODO: find a better way of getting markers to support touch.

diff --git a/src/ext/LineUtil.Intersect.js b/src/ext/LineUtil.Intersect.js index d68554b67..8ea4b9592 100644 --- a/src/ext/LineUtil.Intersect.js +++ b/src/ext/LineUtil.Intersect.js @@ -1,7 +1,7 @@ /** - * @class L.Util + * @class L.LineUtil * @aka Util - * @aka L.LineUtil + * @aka L.Utils */ L.Util.extend(L.LineUtil, {