Commit Graph

9 Commits

Author SHA1 Message Date
Andreas Hocevar
aaf21198d3 Document event stability even when there is no description 2014-05-15 23:02:01 +02:00
Andreas Hocevar
a75d944311 Allow custom events and do not collect events from methods 2014-05-15 20:25:26 +02:00
Tim Schaub
049531831c Move stability and inherited indicators after names 2014-05-14 16:27:30 -06:00
Andreas Hocevar
a613e01677 Only document arguments of exported constructors 2014-05-14 09:06:26 +02:00
Andreas Hocevar
e2c9dd279d Switch to the Jaguar theme
In addition to a nicer layout, this adds a searchable sidebar
and a source code viewer.
2014-05-06 12:46:59 -05:00
Andreas Hocevar
b1126c9373 Inline events and also list method events with the class 2014-05-05 09:35:33 -05:00
Andreas Hocevar
7271b50d5a Simplify fires annotations 2014-05-01 22:17:56 +02: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
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