Commit Graph

15 Commits

Author SHA1 Message Date
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
Paul Spencer
6d3bbe61ce Upgrade to jsdoc 3.3. 2014-04-08 07:39:57 -04:00
ahocevar
d4eb5dd2ee Use a more visually appealing margin for descriptions 2014-03-27 13:00:08 +01:00
ahocevar
4fad17b213 Make clearer what the 'Event' for observable properties means 2014-03-25 18:24:37 +01:00
ahocevar
d0ac615bef Distinct unexported and undocumented symbols 2014-03-25 18:23:05 +01:00
ahocevar
7e850ca33d Use JSDoc's stock event documentation 2014-03-25 18:21:08 +01:00
ahocevar
50f8eb65fd Add capabilities to document events 2014-03-24 21:53:18 +01:00
Frederic Junod
32c2b5311e Move apidoc CSS style out of layout.css 2013-11-21 10:51:59 +01:00
Frederic Junod
fd0a157a39 Remove '(Optional)' from Description 2013-11-14 10:21:23 +01:00
Frederic Junod
b54547a4e1 Fix 'change' event name in apidoc 2013-11-08 08:06:11 +01:00
Paul Spencer
d18119d98b Remove unnecessary Get column from observables 2013-10-28 16:12:08 -04:00
Paul Spencer
d3b8d0b676 Add jsdoc plugin that maps @todo tags to @stability and @observable tags.
This is a temporary measure until Plovr handles custom tags or is replaced in the build system.

Add support for indicating API stability with inline documentation

In preparation for documenting the stability of API features, this commit adds support for indicating API stability via a new jsdoc tag @stability.  There is a small plugin for jsdoc that adds a new tag, @stabiility, with some ability to enforce specific level names.  The templates and css have been updated to include the stability level in the generated documentation. (+1 squashed commit)
Squashed commits:
[d6bc03d] Add jsdoc plugin for documenting observable properties of a class.
2013-10-28 15:17:59 -04:00
Tim Schaub
c4dba8e828 Link to website root 2013-09-24 15:14:49 +02:00
ahocevar
b80022036f ol3 logo for examples and apidoc header 2013-09-24 14:42:04 +02:00
Tim Schaub
4def0c6a84 Differentiating doc from apidoc
This renames the doc task to apidoc.  The apidoc delegates to jsdoc3 currently.  We will have additional documentation that is not built by jsdoc3.  It makes sense to reserve the more general 'doc' name for building all documentation (not just apidoc).
2013-09-23 23:58:25 +02:00