user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rust/src/librustdoc/html/static/js
History
Matthias Krüger 14fbc21466
Rollup merge of #106828 - notriddle:notriddle/notable-trait-docblock, r=GuillaumeGomez 
rustdoc: remove `docblock` class from notable trait popover

This commit builds on b72de9be74, which removes the `docblock` class from the All Items page, and 9457380ac9, which removes the `docblock` class from the item decl.

Fixes #92974
2023-01-14 18:45:27 +01:00
..
externs.js Add comments, fixes for 0 sentinel 2022-06-27 14:15:14 -07:00
main.js Rollup merge of #106828 - notriddle:notriddle/notable-trait-docblock, r=GuillaumeGomez 2023-01-14 18:45:27 +01: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: use a more evocative name for CSS/JS #titles 2022-12-22 18:01:46 -07:00
settings.js rustdoc: rename CSS rustdoc-toggle -> toggle and toggle -> settings-toggle 2023-01-13 12:38:03 -07:00
source-script.js rustdoc: name the source page sidebar-toggle #src-sidebar-toggle 2022-12-15 16:29:52 -07:00
storage.js rustdoc: add hash to filename of toolchain files 2022-10-29 12:47:48 -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