mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #84347 - Swatinem:simplify-document-fns, r=jyn514

Browse Source 
rustdoc: Simplify some document functions

* Remove `prefix` param of `document_short/full`, `render_markdown`, as its always an empty string.
* Remove `Option` wrapping of `document_short` `parent`, as its always `Some`.
This commit is contained in:
Dylan DPC 2021-04-20 11:08:30 +02:00 committed by GitHub
commit 868de80ac2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
src/librustdoc/html/render/mod.rs
View File

@ -509,7 +509,7 @@ fn document(w: &mut Buffer, cx: &Context<'_>, item: &clean::Item, parent: Option
info!("Documenting {}", name); info!("Documenting {}", name);
} }
document_item_info(w, cx, item, false, parent); document_item_info(w, cx, item, false, parent);
document_full(w, item, cx, "", false); document_full(w, item, cx, false);
} }
/// Render md_text as markdown. /// Render md_text as markdown.
@ -518,15 +518,13 @@ fn render_markdown(
cx: &Context<'_>, cx: &Context<'_>,
md_text: &str, md_text: &str,
links: Vec<RenderedLink>, links: Vec<RenderedLink>,
prefix: &str,
is_hidden: bool, is_hidden: bool,
) { ) {
let mut ids = cx.id_map.borrow_mut(); let mut ids = cx.id_map.borrow_mut();
write!( write!(
w, w,
"<div class=\"docblock{}\">{}{}</div>", "<div class=\"docblock{}\">{}</div>",
if is_hidden { " hidden" } else { "" }, if is_hidden { " hidden" } else { "" },
prefix,
Markdown( Markdown(
md_text, md_text,
&links, &links,
@ -546,12 +544,11 @@ fn document_short(
item: &clean::Item, item: &clean::Item,
cx: &Context<'_>, cx: &Context<'_>,
link: AssocItemLink<'_>, link: AssocItemLink<'_>,
prefix: &str,
is_hidden: bool, is_hidden: bool,
parent: Option<&clean::Item>, parent: &clean::Item,
show_def_docs: bool, show_def_docs: bool,
) { ) {
document_item_info(w, cx, item, is_hidden, parent); document_item_info(w, cx, item, is_hidden, Some(parent));
if !show_def_docs { if !show_def_docs {
return; return;
} }
@ -570,39 +567,17 @@ fn document_short(
write!( write!(
w, w,
"<div class='docblock{}'>{}{}</div>", "<div class='docblock{}'>{}</div>",
if is_hidden { " hidden" } else { "" }, if is_hidden { " hidden" } else { "" },
prefix,
summary_html, summary_html,
); );
} else if !prefix.is_empty() {
write!(
w,
"<div class=\"docblock{}\">{}</div>",
if is_hidden { " hidden" } else { "" },
prefix
);
} }
} }
fn document_full( fn document_full(w: &mut Buffer, item: &clean::Item, cx: &Context<'_>, is_hidden: bool) {
w: &mut Buffer,
item: &clean::Item,
cx: &Context<'_>,
prefix: &str,
is_hidden: bool,
) {
if let Some(s) = cx.shared.maybe_collapsed_doc_value(item) { if let Some(s) = cx.shared.maybe_collapsed_doc_value(item) {
debug!("Doc block: =====\n{}\n=====", s); debug!("Doc block: =====\n{}\n=====", s);
render_markdown(w, cx, &*s, item.links(cx), prefix, is_hidden); render_markdown(w, cx, &s, item.links(cx), is_hidden);
} else if !prefix.is_empty() {
if is_hidden {
w.write_str("<div class=\"docblock hidden\">");
} else {
w.write_str("<div class=\"docblock\">");
}
w.write_str(prefix);
w.write_str("</div>");
} }
} }
@ -1547,30 +1522,21 @@ fn render_impl(
// because impls can't have a stability. // because impls can't have a stability.
if item.doc_value().is_some() { if item.doc_value().is_some() {
document_item_info(w, cx, it, is_hidden, Some(parent)); document_item_info(w, cx, it, is_hidden, Some(parent));
document_full(w, item, cx, "", is_hidden); document_full(w, item, cx, is_hidden);
} else { } else {
// In case the item isn't documented, // In case the item isn't documented,
// provide short documentation from the trait. // provide short documentation from the trait.
document_short( document_short(w, it, cx, link, is_hidden, parent, show_def_docs);
w,
it,
cx,
link,
"",
is_hidden,
Some(parent),
show_def_docs,
);
} }
} }
} else { } else {
document_item_info(w, cx, item, is_hidden, Some(parent)); document_item_info(w, cx, item, is_hidden, Some(parent));
if show_def_docs { if show_def_docs {
document_full(w, item, cx, "", is_hidden); document_full(w, item, cx, is_hidden);
} }
} }
} else { } else {
document_short(w, item, cx, link, "", is_hidden, Some(parent), show_def_docs); document_short(w, item, cx, link, is_hidden, parent, show_def_docs);
} }
} }
} }