src/librustdoc/html/static/js/README.md

   1 # Rustdoc JS
   2
   3 These JavaScript files are incorporated into the rustdoc binary at build time,
   4 and are minified and written to the filesystem as part of the doc build process.
   5
   6 We use the [Closure Compiler](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler)
   7 dialect of JSDoc to comment our code and annotate params and return types.
   8 To run a check:
   9
  10     ./x.py doc library/std
  11     npm i -g google-closure-compiler
  12     google-closure-compiler -W VERBOSE \
  13       build/<YOUR PLATFORM>/doc/{search-index*.js,crates*.js} \
  14       src/librustdoc/html/static/js/{search.js,main.js,storage.js} \
  15       --externs src/librustdoc/html/static/js/externs.js >/dev/null