bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

rustdoc: Support short doc fallback for non-default items

Browse source
This commit is contained in:
Manish Goregaokar 2016-05-17 07:31:16 +05:30
parent 38e179769e
commit 8e94b04508
1 changed files with 25 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2565,8 +2565,9 @@ fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLi
} }
fn doctraititem(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item, fn doctraititem(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item,
link: AssocItemLink, render_static: bool, is_default_item: bool, link: AssocItemLink, render_static: bool,
outer_version: Option<&str>) -> fmt::Result { is_default_item: bool, outer_version: Option<&str>,
trait_: Option<&clean::Trait>) -> fmt::Result {
let shortty = shortty(item); let shortty = shortty(item);
let name = item.name.as_ref().unwrap(); let name = item.name.as_ref().unwrap();
@ -2618,16 +2619,33 @@ fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLi
} }
if !is_default_item && (!is_static || render_static) { if !is_default_item && (!is_static || render_static) {
document(w, cx, item)
if item.doc_value().is_some() {
document(w, cx, item)
} else {
// In case the item isn't documented,
// provide short documentation from the trait
if let Some(t) = trait_ {
if let Some(it) = t.items.iter()
.find(|i| i.name == item.name) {
document_short(w, it, link)?;
}
}
Ok(())
}
} else { } else {
document_short(w, item, link)?; document_short(w, item, link)?;
Ok(()) Ok(())
} }
} }
let traits = &cache().traits;
let trait_ = i.trait_did().and_then(|did| traits.get(&did));
write!(w, "<div class='impl-items'>")?; write!(w, "<div class='impl-items'>")?;
for trait_item in &i.inner_impl().items { for trait_item in &i.inner_impl().items {
doctraititem(w, cx, trait_item, link, render_header, false, outer_version)?; doctraititem(w, cx, trait_item, link, render_header,
false, outer_version, trait_)?;
} }
fn render_default_items(w: &mut fmt::Formatter, fn render_default_items(w: &mut fmt::Formatter,
@ -2645,17 +2663,15 @@ fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLi
let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods); let assoc_link = AssocItemLink::GotoSource(did, &i.provided_trait_methods);
doctraititem(w, cx, trait_item, assoc_link, render_static, true, doctraititem(w, cx, trait_item, assoc_link, render_static, true,
outer_version)?; outer_version, None)?;
} }
Ok(()) Ok(())
} }
// If we've implemented a trait, then also emit documentation for all // If we've implemented a trait, then also emit documentation for all
// default items which weren't overridden in the implementation block. // default items which weren't overridden in the implementation block.
if let Some(did) = i.trait_did() { if let Some(t) = trait_ {
if let Some(t) = cache().traits.get(&did) { render_default_items(w, cx, t, &i.inner_impl(), render_header, outer_version)?;
render_default_items(w, cx, t, &i.inner_impl(), render_header, outer_version)?;
}
} }
write!(w, "</div>")?; write!(w, "</div>")?;
Ok(()) Ok(())