Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-08-06 14:10:11 +01:00
Code Issues Projects Releases Packages Wiki Activity

Make doc comments not truncated again.

Browse source 
`rustdoc --passes "collapse-docs unindent-comments"` doesn’t work is intended.
It still generate HTML files that look alright at a glance,
but all doc-comments are truncated to their first line
for some reason I don’t understand.

See http://doc.servo.org/script/dom/index.html for example.
The module documentation there is currently just
“The implementation of the DOM.”, but clicking the [src] link
shows a much larger doc-comment.

https://github.com/rust-lang/rust/issues/15347#issuecomment-122785714

The correct invokation is to use `--passes` multiple times.
This commit is contained in:
Simon Sapin 2015-07-20 09:24:29 +02:00
parent 2f4bdc6ad6
commit bf2dfaf60e
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
etc/rustdoc-with-private
View file

@ -1,4 +1,4 @@
#!/bin/sh
# Skip the strip-private and strip-hidden rustdoc passes
# https://github.com/rust-lang/rust/issues/15347
rustdoc --no-defaults --passes "collapse-docs unindent-comments" "$@"
rustdoc --no-defaults --passes collapse-docs --passes unindent-comments "$@"