Skip to content

Commit 7bf2afd

Browse files
Add highlighting for comments in items declaration
1 parent 891c6ee commit 7bf2afd

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
@@ -1502,7 +1502,7 @@ fn print_tuple_struct_fields<'a, 'cx: 'a>(
15021502
if s.iter()
15031503
.all(|field| matches!(*field.kind, clean::StrippedItem(box clean::StructFieldItem(..))))
15041504
{
1505-
return f.write_str("/* private fields */");
1505+
return f.write_str("<span class=\"comment\">/* private fields */</span>");
15061506
}
15071507

15081508
for (i, ty) in s.iter().enumerate() {
@@ -1659,7 +1659,7 @@ fn render_enum_fields(
16591659
}
16601660

16611661
if variants_stripped && !is_non_exhaustive {
1662-
w.write_str(" // some variants omitted\n");
1662+
w.write_str(" <span class=\"comment\">// some variants omitted</span>\n");
16631663
}
16641664
if toggle {
16651665
toggle_close(&mut w);
@@ -1804,15 +1804,21 @@ fn item_proc_macro(
18041804
let name = it.name.expect("proc-macros always have names");
18051805
match m.kind {
18061806
MacroKind::Bang => {
1807-
write!(buffer, "{name}!() {{ /* proc-macro */ }}").unwrap();
1807+
write!(buffer, "{name}!() {{ <span class=\"comment\">/* proc-macro */</span> }}")
1808+
.unwrap();
18081809
}
18091810
MacroKind::Attr => {
18101811
write!(buffer, "#[{name}]").unwrap();
18111812
}
18121813
MacroKind::Derive => {
18131814
write!(buffer, "#[derive({name})]").unwrap();
18141815
if !m.helpers.is_empty() {
1815-
buffer.write_str("\n{\n // Attributes available to this derive:\n").unwrap();
1816+
buffer
1817+
.write_str(
1818+
"\n{\n \
1819+
<span class=\"comment\">// Attributes available to this derive:</span>\n",
1820+
)
1821+
.unwrap();
18161822
for attr in &m.helpers {
18171823
writeln!(buffer, " #[{attr}]").unwrap();
18181824
}
@@ -2174,7 +2180,7 @@ fn render_union<'a, 'cx: 'a>(
21742180
}
21752181

21762182
if it.has_stripped_entries().unwrap() {
2177-
write!(f, " /* private fields */\n")?;
2183+
write!(f, " <span class=\"comment\">/* private fields */</span>\n")?;
21782184
}
21792185
if toggle {
21802186
toggle_close(&mut f);
@@ -2260,11 +2266,11 @@ fn render_struct_fields(
22602266

22612267
if has_visible_fields {
22622268
if has_stripped_entries {
2263-
write!(w, "\n{tab} /* private fields */");
2269+
write!(w, "\n{tab} <span class=\"comment\">/* private fields */</span>");
22642270
}
22652271
write!(w, "\n{tab}");
22662272
} else if has_stripped_entries {
2267-
write!(w, " /* private fields */ ");
2273+
write!(w, " <span class=\"comment\">/* private fields */</span> ");
22682274
}
22692275
if toggle {
22702276
toggle_close(&mut w);
@@ -2276,7 +2282,7 @@ fn render_struct_fields(
22762282
if fields.iter().all(|field| {
22772283
matches!(*field.kind, clean::StrippedItem(box clean::StructFieldItem(..)))
22782284
}) {
2279-
write!(w, "/* private fields */");
2285+
write!(w, "<span class=\"comment\">/* private fields */</span>");
22802286
} else {
22812287
for (i, field) in fields.iter().enumerate() {
22822288
if i > 0 {

0 commit comments

Comments
 (0)