Skip to content

Commit 05bf5b7

Browse files
Add highlighting for comments in items declaration
1 parent 9bf30eb commit 05bf5b7

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

src/librustdoc/html/render/print_item.rs

+14-8
Original file line numberDiff line numberDiff line change
@@ -1509,7 +1509,7 @@ fn print_tuple_struct_fields<'a, 'cx: 'a>(
15091509
matches!(*field.kind, clean::StrippedItem(box clean::StructFieldItem(..)))
15101510
})
15111511
{
1512-
return f.write_str("/* private fields */");
1512+
return f.write_str("<span class=\"comment\">/* private fields */</span>");
15131513
}
15141514

15151515
for (i, ty) in s.iter().enumerate() {
@@ -1666,7 +1666,7 @@ fn render_enum_fields(
16661666
}
16671667

16681668
if variants_stripped && !is_non_exhaustive {
1669-
w.write_str(" // some variants omitted\n");
1669+
w.write_str(" <span class=\"comment\">// some variants omitted</span>\n");
16701670
}
16711671
if toggle {
16721672
toggle_close(&mut w);
@@ -1811,15 +1811,21 @@ fn item_proc_macro(
18111811
let name = it.name.expect("proc-macros always have names");
18121812
match m.kind {
18131813
MacroKind::Bang => {
1814-
write!(buffer, "{name}!() {{ /* proc-macro */ }}").unwrap();
1814+
write!(buffer, "{name}!() {{ <span class=\"comment\">/* proc-macro */</span> }}")
1815+
.unwrap();
18151816
}
18161817
MacroKind::Attr => {
18171818
write!(buffer, "#[{name}]").unwrap();
18181819
}
18191820
MacroKind::Derive => {
18201821
write!(buffer, "#[derive({name})]").unwrap();
18211822
if !m.helpers.is_empty() {
1822-
buffer.write_str("\n{\n // Attributes available to this derive:\n").unwrap();
1823+
buffer
1824+
.write_str(
1825+
"\n{\n \
1826+
<span class=\"comment\">// Attributes available to this derive:</span>\n",
1827+
)
1828+
.unwrap();
18231829
for attr in &m.helpers {
18241830
writeln!(buffer, " #[{attr}]").unwrap();
18251831
}
@@ -2181,7 +2187,7 @@ fn render_union<'a, 'cx: 'a>(
21812187
}
21822188

21832189
if it.has_stripped_entries().unwrap() {
2184-
write!(f, " /* private fields */\n")?;
2190+
write!(f, " <span class=\"comment\">/* private fields */</span>\n")?;
21852191
}
21862192
if toggle {
21872193
toggle_close(&mut f);
@@ -2267,11 +2273,11 @@ fn render_struct_fields(
22672273

22682274
if has_visible_fields {
22692275
if has_stripped_entries {
2270-
write!(w, "\n{tab} /* private fields */");
2276+
write!(w, "\n{tab} <span class=\"comment\">/* private fields */</span>");
22712277
}
22722278
write!(w, "\n{tab}");
22732279
} else if has_stripped_entries {
2274-
write!(w, " /* private fields */ ");
2280+
write!(w, " <span class=\"comment\">/* private fields */</span> ");
22752281
}
22762282
if toggle {
22772283
toggle_close(&mut w);
@@ -2285,7 +2291,7 @@ fn render_struct_fields(
22852291
matches!(*field.kind, clean::StrippedItem(box clean::StructFieldItem(..)))
22862292
})
22872293
{
2288-
write!(w, "/* private fields */");
2294+
write!(w, "<span class=\"comment\">/* private fields */</span>");
22892295
} else {
22902296
for (i, field) in fields.iter().enumerate() {
22912297
if i > 0 {

0 commit comments

Comments
 (0)