Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[rustdoc] Add highlighting for comments in items declaration #117869

Merged
merged 3 commits into from
Dec 3, 2023
Merged

[rustdoc] Add highlighting for comments in items declaration #117869

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift click to select a range
05bf5b7
Add highlighting for comments in items declaration
GuillaumeGomez Nov 13, 2023
768a614
Add GUI tests for comments highlighting in items declaration
GuillaumeGomez Nov 13, 2023
06695ea
Update snapshots of rustdoc tests to take into account the comment hi…
GuillaumeGomez Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add highlighting for comments in items declaration
  • Loading branch information
@GuillaumeGomez
GuillaumeGomez committed Dec 1, 2023
commit 05bf5b764ab032c7173810dadc3111f6041492a7
22 changes: 14 additions & 8 deletions src/librustdoc/html/render/print_item.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1509,7 1509,7 @@ fn print_tuple_struct_fields<'a, 'cx: 'a>(
matches!(*field.kind, clean::StrippedItem(box clean::StructFieldItem(..)))
})
{
return f.write_str("/* private fields */");
return f.write_str("<span class=\"comment\">/* private fields */</span>");
}

for (i, ty) in s.iter().enumerate() {
Expand Down Expand Up @@ -1666,7 1666,7 @@ fn render_enum_fields(
}

if variants_stripped && !is_non_exhaustive {
w.write_str(" // some variants omitted\n");
w.write_str(" <span class=\"comment\">// some variants omitted</span>\n");
}
if toggle {
toggle_close(&mut w);
Expand Down Expand Up @@ -1811,15 1811,21 @@ fn item_proc_macro(
let name = it.name.expect("proc-macros always have names");
match m.kind {
MacroKind::Bang => {
write!(buffer, "{name}!() {{ /* proc-macro */ }}").unwrap();
write!(buffer, "{name}!() {{ <span class=\"comment\">/* proc-macro */</span> }}")
.unwrap();
}
MacroKind::Attr => {
write!(buffer, "#[{name}]").unwrap();
}
MacroKind::Derive => {
write!(buffer, "#[derive({name})]").unwrap();
if !m.helpers.is_empty() {
buffer.write_str("\n{\n // Attributes available to this derive:\n").unwrap();
buffer
.write_str(
"\n{\n \
<span class=\"comment\">// Attributes available to this derive:</span>\n",
)
.unwrap();
for attr in &m.helpers {
writeln!(buffer, " #[{attr}]").unwrap();
}
Expand Down Expand Up @@ -2181,7 2187,7 @@ fn render_union<'a, 'cx: 'a>(
}

if it.has_stripped_entries().unwrap() {
write!(f, " /* private fields */\n")?;
write!(f, " <span class=\"comment\">/* private fields */</span>\n")?;
}
if toggle {
toggle_close(&mut f);
Expand Down Expand Up @@ -2267,11 2273,11 @@ fn render_struct_fields(

if has_visible_fields {
if has_stripped_entries {
write!(w, "\n{tab} /* private fields */");
write!(w, "\n{tab} <span class=\"comment\">/* private fields */</span>");
}
write!(w, "\n{tab}");
} else if has_stripped_entries {
write!(w, " /* private fields */ ");
write!(w, " <span class=\"comment\">/* private fields */</span> ");
}
if toggle {
toggle_close(&mut w);
Expand All @@ -2285,7 2291,7 @@ fn render_struct_fields(
matches!(*field.kind, clean::StrippedItem(box clean::StructFieldItem(..)))
})
{
write!(w, "/* private fields */");
write!(w, "<span class=\"comment\">/* private fields */</span>");
} else {
for (i, field) in fields.iter().enumerate() {
if i > 0 {
Expand Down