user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rustdoc: Turn the noise down on implemented traits

Browse source 
This commit removes the inherited documentation from type pages. This generally
just clutters up the page when you can click through to the trait itself to get
all the meaty documentation.

Closes #11991
This commit is contained in:
Alex Crichton 2014-05-02 20:16:03 -07:00
parent 4d2877c189
commit d7891c7c0e
1 changed files with 7 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

44
src/librustdoc/html/render.rs
View file

@ -1619,54 +1619,24 @@ fn render_impl(w: &mut Writer, i: &clean::Impl,
None => {}
}
fn docmeth(w: &mut Writer, item: &clean::Item) -> io::IoResult<bool> {
fn docmeth(w: &mut Writer, item: &clean::Item,
dox: bool) -> io::IoResult<()> {
try!(write!(w, "<h4 id='method.{}' class='method'><code>",
*item.name.get_ref()));
try!(render_method(w, item));
try!(write!(w, "</code></h4>\n"));
match item.doc_value() {
Some(s) => {
Some(s) if dox => {
try!(write!(w, "<div class='docblock'>{}</div>", Markdown(s)));
Ok(true)
Ok(())
}
None => Ok(false)
Some(..) | None => Ok(())
}
}
try!(write!(w, "<div class='methods'>"));
for meth in i.methods.iter() {
if try!(docmeth(w, meth)) {
continue
}
// No documentation? Attempt to slurp in the trait's documentation
let trait_id = match trait_id {
None => continue,
Some(id) => id,
};
try!(local_data::get(cache_key, |cache| {
let cache = cache.unwrap();
match cache.traits.find(&trait_id) {
Some(t) => {
let name = meth.name.clone();
match t.methods.iter().find(|t| t.item().name == name) {
Some(method) => {
match method.item().doc_value() {
Some(s) => {
try!(write!(w,
"<div class='docblock'>{}</div>",
Markdown(s)));
}
None => {}
}
}
None => {}
}
}
None => {}
}
Ok(())
}))
try!(docmeth(w, meth, true));
}
// If we've implemented a trait, then also emit documentation for all
@ -1685,7 +1655,7 @@ fn render_impl(w: &mut Writer, i: &clean::Impl,
None => {}
}
try!(docmeth(w, method.item()));
try!(docmeth(w, method.item(), false));
}
}
None => {}