This reflects changes in Google's policy on JavaScript license
headers, which should be smaller to avoid increasing the size of the
binary unnecessarily.
This also updates the company name from "Google, Inc" to "Google LLC".
Change-Id: I3f8b9ed3700b6351f43173d50c94d35c333e82b4
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
This is required by Google policy, to document where these forks came
from and what their licensing terms are. I overlooked this detail
when I started customizing the JSDoc template.
Change-Id: Ifd18bb3143ca841e2bd934fe571f3a896ba53975
This feature is based on a forked version of jsdoc which we hope to
land https://github.com/jsdoc3/jsdoc/pull/1502 upstream.
Closes#1259
Change-Id: I48e07ffd8ae9fc2c07cd48b3e02b85e87694d341
Replace generic "function" and "record" types with their original types.
With this, we see, for example:
"function(string):number" instead of just "function"
"{{ foo: string, bar: number }}" instead of just "Object"
Issue #1259
Change-Id: Icd5ddbacadb7ec799e025b67f311792dd590b310
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
This is a customization that allows us to link to the source code of
a thing, rather than its documentation.
Redoing this in a clean way caught some bad links, which have now been
fixed.
Issue #1259
Change-Id: I4c63aa10ddad8f8f21b224668c3529c70a1c6756
We now show enum values in the generated documentation. Further, a
URL fragment of "value:6001", for example, would highlight and scroll
directly to the row in which value 6001 is described. This is used
by the demo app to take users directly to the appropriate docs for a
given error code.
Issue #1259
Change-Id: Iae47e661db2bba43eb16a4f3fd1476adea59aecb
- 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
We can now specify in a config file what order the nav elements should
be in, and which nav elements should appear.
Issue #1259
Change-Id: I4caa3a0585b4140e76a66f1c5bed0c20c82ca5a4
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
Joey Parrish