Commit Graph

22 Commits

Author SHA1 Message Date
Andreas Hocevar
267a950435 Mention the need to re-render in a single place only 2014-09-11 13:13:17 -07:00
Andreas Hocevar
0e14639633 Update docs for changes proposed in #2684 2014-09-04 21:01:50 -06:00
Andreas Hocevar
88c30795d3 Doc improvements 2014-09-04 13:20:25 -06:00
Andreas Hocevar
0c36d7606b No need to have a mutable_ flag
Instead, educate users to call setStyle.
2014-09-04 11:47:32 -06:00
Andreas Hocevar
a50f6d7a2f Mutable symbolizer properties for style functions
This change adds setters for symbolizer properties. In addition, it
introduces a mutable flag on all styles. By default, this is set to
true. ol.style.createStyleFunction sets it to false for all static
styles.

The new setters assert that the mutable flag is true, so whenever an
application tries to set a symbolizer property on a style that was
assigned to a vector layer or feature overlay, the assertion will fail.
2014-09-03 16:57:50 -06:00
Peter Robins
bf3770a9da Improve docs for style 2014-08-05 09:04:35 +00:00
Tim Schaub
4cf5ab4620 Use @api annotation instead of @todo api 2014-07-05 15:41:14 -04:00
Peter Robins
41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04:00
Andreas Hocevar
fbdbbfb7a7 Get rid of stability annotations and document stability with api
This change adds a stability value to the api annotation, with
'experimental' as default value.

enum, typedef and event annotations are never exportable, but
api annotations are needed there to make them appear in the
docs.

Nested typedefs are no longer inlined recursively, because the
resulting tables get too wide with the current template.
2014-04-29 09:53:07 -06:00
Andreas Hocevar
c17ac0cae3 Greatly simplify and document the usage of JSDoc
This commit simplifies the exports.js plugin so it only relies
on the stability notes to generate the documentation, which
completely decouples it from the exportable API.

As a rule of thumb, whenever something has an 'api' annotation,
it should also have a 'stability' annotation. A more verbose
documentation of ol3 specific annotation usage is available in
the new 'apidoc/readme.md' file.

This commit also modifies all source files to implement these
usage suggestions.
2014-04-29 09:53:06 -06:00
Tim Schaub
fb497f5288 Annotations for exports 2014-04-29 09:53:05 -06:00
Éric Lemoine
d4d9cb6a3a Add getters to ol.style.Stroke 2013-12-19 14:37:57 +01:00
Tom Payne
aae425eb59 Make options argument to ol.style.Stroke optional 2013-12-13 22:59:12 +01:00
Éric Lemoine
35d5158454 Merge remote-tracking branch 'upstream/master' into vector-api
Conflicts:
	src/objectliterals.jsdoc
	src/ol/attribution.js
	src/ol/geom/geometry.js
	src/ol/geom/geometrycollection.js
	src/ol/geom/linestring.js
	src/ol/layer/vectorlayer.exports
	src/ol/layer/vectorlayer.js
	src/ol/map.js
	src/ol/proj/proj.js
	src/ol/renderer/canvas/canvasvectorlayerrenderer.js
	src/ol/source/imagewmssource.js
	src/ol/source/tilewmssource.js
	src/ol/source/vectorsource.exports
	src/ol/source/vectorsource.js
	src/ol/source/wmssource.js
	src/ol/style/style.js
	src/ol/tilegrid/tilegrid.js
	src/ol/tilegrid/wmtstilegrid.js
	src/ol/tilegrid/xyztilegrid.js
2013-12-13 12:53:57 +01:00
Frederic Junod
0908490385 Add lineDash property to ol.style.Stroke 2013-11-28 13:47:31 +01:00
Frederic Junod
bf9cd0a675 Add miterLimit property to ol.style.Stroke 2013-11-28 11:49:56 +01:00
Frederic Junod
0bd77d3caf Add lineJoin property to ol.style.Stroke 2013-11-28 11:31:06 +01:00
Frederic Junod
b8dbac77bc Remove unused ol.style.Stroke.equals 2013-11-28 10:03:07 +01:00
Frederic Junod
b210073ef0 Add lineCap property to ol.style.Stroke 2013-11-28 09:36:54 +01:00
Éric Lemoine
66bda92597 Make setting stroke color and width optional 2013-11-22 11:49:13 +01:00
Éric Lemoine
dc49cc4c2f Export ol.style.Stroke 2013-11-20 15:35:11 +01:00
Éric Lemoine
f1d67f69c3 Add ol.style.Stroke constructor 2013-11-20 15:35:09 +01:00