Commit Graph

27 Commits

Author SHA1 Message Date
Bart van den Eijnden
47ce127a10 Add assert messages for all assertions up until ol.renderer.vector. 2015-03-30 22:55:23 +02:00
Tim Schaub
d99a61545c Use @observable annotation instead of @todo observable 2014-07-05 16:16:44 -04:00
Tim Schaub
4cf5ab4620 Use @api annotation instead of @todo api 2014-07-05 15:41:14 -04:00
Peter Robins
928b05e857 Correct minor typo in ol.dom.Input docs 2014-06-24 12:04:42 +01:00
Peter Robins
41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04:00
Andreas Hocevar
8ee9f7cb6a Simplify the way we annotate observable properties
We no longer add observable annotations to the constructor.
Instead, we just mark getters (and for read/write properties
also setters) with an observable annotation.
2014-05-03 16:04:25 -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
Frederic Junod
03b979c30a Listen to 'input' and 'change' events 2014-02-19 11:37:05 +01:00
Frederic Junod
4e7d697273 Add missing function arguments 2014-02-19 11:37:05 +01:00
Frederic Junod
c9e9cbc7c8 Change ol.dom.Input target param from Element to HTMLInputElement 2014-02-19 11:37:05 +01:00
Frederic Junod
1e0ce96e9f Remove 'valueAsNumber' property from observable list
The property was removed in a0bea641d1
2014-02-19 09:53:46 +01:00
Tom Payne
ae5f5ee96d Factor out common variable in ol.dom.Input 2014-01-30 11:20:58 +01:00
Frederic Junod
a0bea641d1 Remove 'valueAsNumber' property from ol.dom.Input
Use bindTo.transform functions instead
2013-11-13 16:13:08 +01:00
Frederic Junod
d3be7d9d18 Set boolean value to HTMLInputElement.checked
See http://www.whatwg.org/specs/web-apps/current-work/multipage/the-input-element.html#attr-input-checked
2013-11-12 10:24:36 +01:00
Frédéric Junod
a05c426212 Merge pull request #1186 from fredj/validate_valueAsNumber
mouse-position example: Projection select issue
2013-10-31 23:49:48 -07:00
Frederic Junod
a2b9f1d0ac Only set the 'valueAsNumber' property is the value is valid 2013-10-30 14:15:59 +01:00
Paul Spencer
4e657e464c Add @todo observable documentation for observable properties
This PR adds documentation for observable properties, which will then be pulled into the docs correctly once #1180 is merged.  This is a first pass based on searching for definition of observable properties being defined as enums after lines ending with `Property = {`.  If there are observable properties implemented that don't follow this pattern then they are not included.

I've added simple descriptions based on what I know or could easily figure out, there may be some properties (like preload) that are not correctly described.

I've also added `readonly` annotations where I knew that a property was readonly.  I may have missed some readonly properties.

ol.layer.Base has a bunch of properties but I don't think it is exported so the documentation of these properties will not show up, so I added the documentation to ol.layer.Layer instead even though this isn't really where it should be documented.
2013-10-29 10:24:54 -04:00
Paul Spencer
bada596b45 Add default stability level to docs of exported things. 2013-10-24 18:20:24 -04:00
Frederic Junod
ef929e9a72 Fix jsdoc formating 2013-09-24 12:18:00 +02:00
Bruno Binet
afee1ab975 Add VALUE_AS_NUMBER property to ol.dom.Input
This should be used when one want to bind a number instead of a string.
2013-08-13 11:31:58 +02:00
Bart van den Eijnden
8dc97790bc Add more content for the API doc
Involves additions to (there will be subsequent pull requests for other
classes):
- ol.Attribution
- ol.Collection
- ol.Expression
- ol.Feature
- ol.Geolocation
- ol.Map
- ol.Object
- ol.Overlay
- ol.Projection
- ol.View2D
- ol.control.Attribution
- ol.control.Control
- ol.control.FullScreen
- ol.control.Logo
- ol.control.MousePosition
- ol.control.ScaleLine
- ol.control.Zoom
- ol.control.ZoomSlider
- ol.dom.Input
- ol.filter.Filter
- ol.filter.Geometry
- ol.filter.Logical
2013-06-11 20:56:04 +02:00
Frederic Junod
984002a7ec Change ol.Object event name syntax
'changed' to 'change' and '<attribute>_changed' to 'change:<attribute>'.
2013-05-31 12:38:37 +02:00
Tom Payne
f1cc5b87da Fix whitespace errors in JavaScript source 2013-04-08 13:25:01 +02:00
Tom Payne
4be8c991f7 Add missing Closure Library requires 2013-04-06 14:28:12 +02:00
Frederic Junod
7ee9a4c8a3 Add ol.dom.Input 2013-03-18 16:24:31 +01:00