user0/rust

History

Roy Wellington Ⅳ ee9e8cd0ec This function appears to be unused The comment says that it is called from main.js, but there don't seem to be any references to it in main.js. A quick ripgrep says there are no references in all of librustdoc.		2023-01-21 17:33:49 -05:00
..
externs.js	Add comments, fixes for `0` sentinel	2022-06-27 14:15:14 -07:00
main.js	rustdoc: fix "?" keyboard command when radio button is focused	2023-01-18 12:14:00 -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: simplify JS search routine by not messing with lev distance	2023-01-14 12:04:11 -07:00
settings.js	rustdoc: instead of `.setting-name { width: 100% }`, use default div CSS	2023-01-17 11:49:36 -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	This function appears to be unused	2023-01-21 17:33:49 -05: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