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

rustdoc: fold fields for enum struct variants into a docblock

Browse Source
This commit is contained in:
QuietMisdreavus 2016-11-11 16:41:00 -06:00
parent 5293b913c4
commit fff921672f
3 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/librustdoc/html/render.rs
View File

@ -2467,8 +2467,13 @@ fn item_enum(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
if let clean::VariantItem(Variant {
kind: VariantKind::Struct(ref s)
}) = variant.inner {
write!(w, "<h3 class='fields'>Fields</h3>\n
<table>")?;
let variant_id = derive_id(format!("{}.{}.fields",
ItemType::Variant,
variant.name.as_ref().unwrap()));
write!(w, "<span class='docblock autohide sub-variant' id='{id}'>",
id = variant_id)?;
write!(w, "<h3 class='fields'>Fields of <code>{name}</code></h3>\n
<table>", name = variant.name.as_ref().unwrap())?;
for field in &s.fields {
use clean::StructFieldItem;
if let StructFieldItem(ref ty) = field.inner {
@ -2492,7 +2497,7 @@ fn item_enum(w: &mut fmt::Formatter, cx: &Context, it: &clean::Item,
write!(w, "</td></tr>")?;
}
}
write!(w, "</table>")?;
write!(w, "</table></span>")?;
}
render_stability_since(w, variant, it)?;
}

16
src/librustdoc/html/static/main.js
View File

@ -1013,6 +1013,22 @@
.html('&nbsp;Expand&nbsp;description'));
var wrapper = $("<div class='toggle-wrapper'>").append(mainToggle);
$("#main > .docblock").before(wrapper);
$(".docblock.autohide").each(function() {
var wrap = $(this).prev();
if (wrap.is(".toggle-wrapper")) {
var toggle = wrap.children().first();
if ($(this).children().first().is("h3")) {
toggle.children(".toggle-label")
.text(" Show " + $(this).children().first().text());
}
$(this).hide();
wrap.addClass("collapsed");
toggle.children(".inner").text(labelForToggleButton(true));
toggle.children(".toggle-label").show();
}
});
var mainToggle =
$(toggle).append(
$('<span/>', {'class': 'toggle-label'})

8
src/librustdoc/html/static/rustdoc.css
View File

@ -339,6 +339,10 @@ h4 > code, h3 > code, .invisible > code {
border-bottom: 1px solid;
}
.fields + table {
margin-bottom: 1em;
}
.content .item-list {
list-style-type: none;
padding: 0;
@ -663,6 +667,10 @@ span.since {
margin-top: 5px;
}
.sub-variant, .sub-variant > h3 {
margin-top: 0 !important;
}
.enum > .toggle-wrapper + .docblock, .struct > .toggle-wrapper + .docblock {
margin-left: 30px;
margin-bottom: 20px;