Commit Graph

20 Commits

Author SHA1 Message Date
Peter Robins
41d9f0360a Add @classdesc to classes 2014-06-09 12:10:19 -04:00
Frederic Junod
47f99f64ef Mark ol.format.GPX#readProjection as a function 2014-05-27 08:30:48 +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
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
68773941d3 Use goog.array.contains instead of goog.array.indexOf 2014-04-26 08:31:40 +02:00
Tom Payne
06dc1aa4f2 Suppress warning about fall-through in switch statement 2014-03-23 19:59:49 +01:00
Paul Spencer
3c85c32cc5 Add documentation for the GPX format. 2014-03-11 20:53:21 -04:00
Tom Payne
56b6913a01 Rename ol.format.XML to ol.format.XMLFeature 2014-02-28 13:13:11 +01:00
ahocevar
bb38771096 No magic for namespace URI 2014-02-24 14:13:41 +01:00
ahocevar
7b56abdac7 Get rid of compiler warnings 2014-02-23 01:50:59 +01:00
ahocevar
696425af36 Documentation and cleanup 2014-02-21 22:49:33 +01:00
ahocevar
480a6a85ba Add trk serialization for ol.format.GPX 2014-02-21 20:27:04 +01:00
ahocevar
791cb2415b Simplify annotations 2014-02-21 20:22:44 +01:00
ahocevar
1354d8ce78 Added rte serialization for ol.format.GPX 2014-02-21 16:55:48 +01:00
ahocevar
b4043398eb Added wpt serialization for ol.format.GPX 2014-02-21 07:18:42 +01:00
Tom Payne
d033801a84 Add stability annotation to ol.format.GPX 2014-02-03 14:59:13 +01:00
Tom Payne
432d10a457 Rename ol.xml.pushAndParse to ol.xml.pushParseAndPop 2014-01-20 16:47:56 +01:00
Tom Payne
917b6cda8f Add ol.source.GPX 2014-01-16 22:44:18 +01:00
Tom Payne
fa89c1c3a3 Add ol.format.GPX 2014-01-16 22:44:18 +01:00