Commit Graph

10 Commits

Author SHA1 Message Date
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
Tom Payne
1a643e1b37 Fix parsing of EX_GeographicBoundingBox when ol3 is compiled 2014-03-12 14:25:23 +01:00
Frederic Junod
924ecba95c Fix coding style 2014-03-10 17:22:35 +01:00
Frederic Junod
2fdae368c2 Check if the EX_GeographicBoundingBox is correctly parsed 2014-03-10 17:18:04 +01:00
Frederic Junod
ea8c004c76 Remove unneeded type cast 2014-03-10 17:13:16 +01:00
Frederic Junod
1c13d6ed69 Add ol.format.WMSCapabilities 2014-03-10 17:06:48 +01:00