Commit Graph

37 Commits

Author SHA1 Message Date
Frederic Junod aa40504dd5 Improve ol.Collection documentation 2014-08-29 07:27:35 +02:00
Éric Lemoine 711c4bbc8c Merge pull request #2450 from probins/events
Improve and standardise event docs
2014-08-18 17:35:59 +02:00
Peter Robins 7a5a5d75e7 Improve and standardise event docs 2014-08-18 15:17:02 +00:00
Frederic Junod 93218e5db4 Templatize ol.Collection 2014-07-30 09:09:33 +02:00
Peter Robins 307ee09988 Improve Collection docs 2014-07-14 09:20:25 +00: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
Éric Lemoine 601f0d8fd2 Add stable tags to ol.Collection 2014-06-19 10:35:04 +02:00
Tim Schaub 2a42e7736a Merge pull request #2178 from probins/classdesc
Use @classdesc notation.
2014-06-09 11:18:14 -06:00
Peter Robins 41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04:00
Frederic Junod 4525276c6e Rename ol.Collection#getAt to ol.Collection#item
TouchList, DOMStringList, DOMTokenList, NodeList all have an
`item(index)` function to retrieve an item from a list.
We should do the same.
2014-06-06 09:49:12 +02:00
Andreas Hocevar 547334e211 Move oli.* stability notes to the corresponding ol.* symbol 2014-05-22 16:01:35 +02: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 7271b50d5a Simplify fires annotations 2014-05-01 22:17:56 +02: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
Tim Schaub fb497f5288 Annotations for exports 2014-04-29 09:53:05 -06:00
ahocevar a3b5376520 Add missing event documentation and stability tags 2014-03-26 14:04:58 +01:00
Tom Payne 271487c1bc Remove leading whitespace 2014-03-12 19:52:13 +01:00
Tom Payne 3d68a3550e Convert ol.CollectionEvent#getElement method into element property 2014-01-27 15:52:03 +01:00
Tom Payne 4d5a248803 Use opt_this instead of opt_obj in ol.Collection 2014-01-15 14:49:42 +01:00
Tom Payne e487e1b215 Improve type checking in ol.Collection 2013-11-20 10:57:45 +01:00
Frederic Junod 01cc19af80 More precise {function} jsdoc definition 2013-11-07 16:03:19 +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
Éric Lemoine d68f411e82 Add doc for ol.Collection#getArray 2013-09-02 18:24:07 +02:00
Éric Lemoine b9f2f7bcb4 Add ol.CollectionEvent#getElement 2013-08-27 22:07:03 +02:00
Éric Lemoine 6576a49178 Make ol.Collection#extend return this
This to be able to do this:

new ol.Map({
  controls: ol.control.defaults().extend([new MyControl()]),
  ...
})
2013-08-19 14:25:38 +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
Tom Payne 332fd250b4 Cache array length in ol.Collection 2013-04-20 11:27:44 +02:00
Tom Payne 3e7c913c44 Add ol.Collection.remove 2013-03-06 15:53:11 +01:00
Tom Payne 905a0059db Remove unused insert_at, set_at, and remove_at events 2013-03-06 15:50:03 +01:00
Tom Payne 23f0097517 Add ol.Collection.extend 2013-03-06 13:18:34 +01:00
Tim Schaub 0707deb465 Properties set with set should not be accessed with bracket 2013-02-19 14:28:59 -07:00
Tom Payne b6f856f962 Remove unused goog.requires 2013-01-30 22:48:03 +01:00
Tom Payne 3f08995cfb Fix typecast in ol.Collection 2013-01-07 13:18:59 +01:00
Tim Schaub c3a41c967e Removing file overviews for now. 2012-09-24 16:58:55 +02:00
Tom Payne f8c31ba45c s/ol3/ol/ 2012-09-24 14:21:41 +02:00