rust/src/librustdoc/html/static/js
2023-04-17 10:28:28 -07:00
..
externs.js rustdoc-search: use ES6 Map for Result instead of Object 2023-04-13 17:40:06 -07:00
main.js rustdoc: stop passing a title to replaceState second argument 2023-04-15 13:15:48 -07:00
README.md Add some JSDoc comments to rustdoc JS 2021-12-22 14:20:04 -08:00
scrape-examples.js Improve calculation of scraped example minimized height 2022-12-07 10:42:09 -08:00
search.js rustdoc-search: fix incorrect doc comment 2023-04-17 10:28:28 -07:00
settings.js rustdoc: clean up JS 2023-04-06 16:25:38 -07:00
source-script.js rustdoc: use CSS overscroll-behavior instead of JavaScript 2023-04-12 10:31:06 -07:00
storage.js Rollup merge of #110037 - notriddle:notriddle/theme-default, r=GuillaumeGomez 2023-04-08 10:26:14 +02:00

Rustdoc JS

These JavaScript files are incorporated into the rustdoc binary at build time, and are minified and written to the filesystem as part of the doc build process.

We use the Closure Compiler dialect of JSDoc to comment our code and annotate params and return types. To run a check:

./x.py doc library/std
npm i -g google-closure-compiler
google-closure-compiler -W VERBOSE \
  build/<YOUR PLATFORM>/doc/{search-index*.js,crates*.js} \
  src/librustdoc/html/static/js/{search.js,main.js,storage.js} \
  --externs src/librustdoc/html/static/js/externs.js >/dev/null