user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rust/src/librustdoc/html/static/js
History
Michael Howell ce795d9ca8 rustdoc: collapse edit distance state into an object
2023-03-11 20:39:15 -07:00
..
externs.js Add comments, fixes for 0 sentinel 2022-06-27 14:15:14 -07:00
main.js Only load one CSS theme by default 2023-03-08 12:49:34 -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: collapse edit distance state into an object 2023-03-11 20:39:15 -07:00
settings.js Rollup merge of #107177 - thanatos:fix-doc-errant-light-theme, r=notriddle 2023-01-30 17:50:09 +01:00
source-script.js Clean up JS files code a bit 2023-02-26 20:58:36 +01:00
storage.js Update src/librustdoc/html/static/js/storage.js 2023-03-08 12:49:35 -07:00

README.md

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