Commit Graph

4 Commits

Author SHA1 Message Date
Joey Parrish d16e1a4a4a Update our fork of the jsdoc default template
This updates our fork to match the latest code in jsdoc v4.0.0-dev.
This was done by diffing our forked template against v3.5.5, then
reapplying the same changes to the latest default template from
v4.0.0-dev.

Fixes #1312 (regex backtracking vulnerability in jsdoc template)

Change-Id: I6bbac557ad45a443b0faa58be0842f2f30a85848
2019-05-15 20:32:34 +00:00
Joey Parrish c2472dcffc Allow the user to show/hide parts of the docs
This adds custom CSS classes and a widget to show/hide various parts
of the docs.  By default, we show exported interfaces only.  The user
can also select "public" (all public interfaces, even those not
exported), and "everything" (even private members).

Issue #1259

Change-Id: Iff8f4d84658a3d19ad8f2f979ab37b256393589f
2018-02-01 21:55:01 +00:00
Joey Parrish a324958f2c Tweak jsdoc formatting
- always show Constructor heading for class constructors
 - hide top-level header that just repeats information from elsewhere
 - show namespace descriptions as a "class description" at the top
 - remove 2 redundant headers from tutorials that repeat the title
 - use a gray background for inline code, as github does
 - put more space between headings within a tutorial

Issue #1259

Change-Id: I7eedd69b7a732da0f3292912ec07d97eccb44eed
2018-01-31 22:04:48 +00:00
Joey Parrish ed54199260 Upgrade and unfork jsdoc
This updates jsdoc to the latest version from npm and forks a copy of
the default jsdoc template.

In subsequent commits, we will reapply our customizations to the
template and to a jsdoc plugin.

This also fixes several bad annotations that the new jsdoc failed to
parse.

Issue #1259

Change-Id: I00a47270ea4754e1c96c43ca900d5cf889ab72e6
2018-01-31 22:04:48 +00:00