Commit Graph

7 Commits

Author SHA1 Message Date
Andreas Hocevar
e050c905e2 Do not include oli.* symbols in the inheritance chain 2014-05-22 15:48:46 +02:00
Andreas Hocevar
959e14c31a Handle observables and fires augments in plugins
This makes it easier to switch themes.
2014-05-06 10:14:28 -05:00
Andreas Hocevar
61b732b8f7 Make sure that parent classes are not marked undocumented 2014-05-05 09:40:28 -05:00
Andreas Hocevar
db5b2e284a Do not remove classes that other classes inherit from 2014-05-03 12:41:52 +02:00
Andreas Hocevar
d6722ddc6f Mark undocumented doclets as undocumented
To give other plugins access to doclets that are not part of
the API, we have to mark them undocumented instead of removing
them. They will be removed by JSDoc before publishing anyway.
2014-05-02 12:06: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