Commit Graph

5 Commits

Author SHA1 Message Date
Bart van den Eijnden
304e7c7df7 Add properties found in objectliterals.jsdoc to the API 2014-02-11 14:49:04 +01:00
Éric Lemoine
7fa3a38081 external/src/types.js file no longer exists 2013-12-12 16:57:39 +01:00
Paul Spencer
e858727bd0 Fix @todo observable name reference. 2013-10-28 16:11:40 -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
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