user0/rust

History

Michael Howell 7b926555b7 rustdoc-search: add search query syntax `Fn(T) -> U` This is implemented, in addition to the ML-style one, because Rust does it. If we don't, we'll never hear the end of it. This commit also refactors some duplicate parts of the parser into a dedicated function.		2024-03-11 22:27:22 -07:00
..
externs.js	rustdoc-search: fix inaccurate type descriptions	2023-12-30 22:53:52 -07:00
main.js	Correctly handle if rustdoc JS script hash changed	2024-02-25 16:28:38 +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-search: add search query syntax `Fn(T) -> U`	2024-03-11 22:27:22 -07:00
settings.js	Rollup merge of #115660 - notriddle:notriddle/sidebar-resize, r=GuillaumeGomez	2023-12-15 11:51:23 +01:00
src-script.js	Add back the column	2023-12-18 12:42:24 -07:00
storage.js	rustdoc: Prevent JS injection from localStorage	2024-01-29 18:25:56 +00: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