rustdoc: Add stability notices to impl items
Also fixes missing stability notices on methods with no docs.
This commit is contained in:
parent
2940eb54bd
commit
195fc5a325
2 changed files with 158 additions and 17 deletions
|
@ -1658,12 +1658,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(())
|
||||
}
|
||||
|
||||
|
@ -1680,6 +1676,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)?;
|
||||
|
@ -2640,20 +2650,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)?;
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue