bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Auto merge of #34292 - ollie27:rustdoc_depr_impl, r=GuillaumeGomez

Browse source 
rustdoc: Add stability notices to impl items

Also fixes missing stability notices on methods with no docs.

For example [`f64::is_positive`](https://doc.rust-lang.org/nightly/std/primitive.f64.html#method.is_positive) is missing its deprecation message.
This commit is contained in:
bors 2016-06-17 11:12:00 -07:00 • committed by GitHub
commit 1f9423a87a
2 changed files with 158 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1656,12 +1656,8 @@ fn plain_summary_line(s: Option<&str>) -> String {
}
fn document(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
for stability in short_stability(item, cx, true) {
write!(w, "<div class='stability'>{}</div>", stability)?;
}
if let Some(s) = item.doc_value() {
write!(w, "<div class='docblock'>{}</div>", Markdown(s))?;
}
document_stability(w, cx, item)?;
document_full(w, item)?;
Ok(())
}
@ -1678,6 +1674,20 @@ fn document_short(w: &mut fmt::Formatter, item: &clean::Item, link: AssocItemLin
Ok(())
}
fn document_full(w: &mut fmt::Formatter, item: &clean::Item) -> fmt::Result {
if let Some(s) = item.doc_value() {
write!(w, "<div class='docblock'>{}</div>", Markdown(s))?;
}
Ok(())
}
fn document_stability(w: &mut fmt::Formatter, cx: &Context, item: &clean::Item) -> fmt::Result {
for stability in short_stability(item, cx, true) {
write!(w, "<div class='stability'>{}</div>", stability)?;
}
Ok(())
}
fn item_module(w: &mut fmt::Formatter, cx: &Context,
item: &clean::Item, items: &[clean::Item]) -> fmt::Result {
document(w, cx, item)?;
@ -2638,20 +2648,23 @@ fn render_impl(w: &mut fmt::Formatter, cx: &Context, i: &Impl, link: AssocItemLi
if !is_static || render_static {
if !is_default_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)?;
}
if let Some(t) = trait_ {
let it = t.items.iter().find(|i| i.name == item.name).unwrap();
// We need the stability of the item from the trait because
// impls can't have a stability.
document_stability(w, cx, it)?;
if item.doc_value().is_some() {
document_full(w, item)?;
} else {
// In case the item isn't documented,
// provide short documentation from the trait.
document_short(w, it, link)?;
}
} else {
document(w, cx, item)?;
}
} else {
document_stability(w, cx, item)?;
document_short(w, item, link)?;
}
}