Commit Graph

18 Commits

Author SHA1 Message Date
ahocevar
a5d8f463ff Clean up
Only mark symbol as unexported when it is not in the API, and
no longer extract links from fires annotations because all links
are handled now.
2014-03-27 12:37:01 +01:00
ahocevar
15b0bc719e Do not loop through parents
Now that we use the parseComplete event, we walk through all
doclets in the loop anyway.
2014-03-27 01:56:31 +01:00
ahocevar
a1d9491d62 Do not delete event and fires doclets 2014-03-27 01:18:59 +01:00
ahocevar
cc1fceab05 Do not query the array twice 2014-03-26 23:46:42 +01:00
ahocevar
e5edb5c0e3 Also consider linked symbols as documented 2014-03-26 18:33:15 +01:00
ahocevar
f129a68248 Only add symbols to the unexported array once
This basically fixes a typo that caused unexported symbols to
be added to the unexported array multiple times.
2014-03-26 18:32:36 +01:00
ahocevar
118d9c200a Remove undocumented symbols at the end of the parsing process
This ensures that we do not mark symbols as undocumented before
all potential dependencies are parsed.
2014-03-26 18:31:31 +01:00
ahocevar
a3b5376520 Add missing event documentation and stability tags 2014-03-26 14:04:58 +01:00
ahocevar
7a9353cc87 Document classes and properties from externs/oli.js 2014-03-25 18:24:09 +01:00
ahocevar
d0ac615bef Distinct unexported and undocumented symbols 2014-03-25 18:23:05 +01:00
ahocevar
026c7149c8 Fix @override documentation 2014-03-25 18:21:55 +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
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