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

Show file tree
Hide file tree
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
Prev Previous commit
Next Next commit
Add GUI tests for comments highlighting in items declaration
  • Loading branch information
@GuillaumeGomez
GuillaumeGomez committed Dec 1, 2023
commit 768a614380813a66c5b97ca4a02b721ea7916868
73 changes: 73 additions & 0 deletions tests/rustdoc-gui/item-decl-comment-highlighting.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,73 @@
// This test checks that comments in item declarations are highlighted.
go-to: "file://" |DOC_PATH| "/test_docs/private/enum.Enum.html"
show-text: true

define-function: (
"check-item-decl-comment",
(theme, url, comment_color),
block {
go-to: |url|
set-local-storage: {"rustdoc-theme": |theme|, "rustdoc-use-system-theme": "false"}
reload:
assert-css: (".item-decl .comment", {"color": |comment_color|}, ALL)
}
)

define-function: (
"check-items-for-theme",
(theme, comment_color),
block {
call-function: ("check-item-decl-comment", {
"theme": |theme|,
"url": "file://" |DOC_PATH| "/test_docs/private/enum.Enum.html",
"comment_color": |comment_color|,
})
call-function: ("check-item-decl-comment", {
"theme": |theme|,
"url": "file://" |DOC_PATH| "/test_docs/private/struct.Struct.html",
"comment_color": |comment_color|,
})
call-function: ("check-item-decl-comment", {
"theme": |theme|,
"url": "file://" |DOC_PATH| "/test_docs/private/struct.Tuple.html",
"comment_color": |comment_color|,
})
call-function: ("check-item-decl-comment", {
"theme": |theme|,
"url": "file://" |DOC_PATH| "/test_docs/private/union.Union.html",
"comment_color": |comment_color|,
})
call-function: ("check-item-decl-comment", {
"theme": |theme|,
"url": "file://" |DOC_PATH| "/proc_macro_test/macro.make_answer.html",
"comment_color": |comment_color|,
})
call-function: ("check-item-decl-comment", {
"theme": |theme|,
"url": "file://" |DOC_PATH| "/proc_macro_test/derive.HelperAttr.html",
"comment_color": |comment_color|,
})
}
)

call-function: (
"check-items-for-theme",
{
"theme": "ayu",
"comment_color": "#788797",
}
)
call-function: (
"check-items-for-theme",
{
"theme": "dark",
"comment_color": "#8d8d8b",
}
)
call-function: (
"check-items-for-theme",
{
"theme": "light",
"comment_color": "#8e908c",
}
)
2 changes: 1 addition & 1 deletion tests/rustdoc-gui/sidebar-source-code.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 73,7 @@ assert: "//*[@class='dir-entry' and @open]/*[text()='sub_mod']"
// Only "another_folder" should be "open" in "lib2".
assert: "//*[@class='dir-entry' and not(@open)]/*[text()='another_mod']"
// All other trees should be collapsed.
assert-count: ("//*[@id='src-sidebar']/details[not(text()='lib2') and not(@open)]", 10)
assert-count: ("//*[@id='src-sidebar']/details[not(text()='lib2') and not(@open)]", 11)

// We now switch to mobile mode.
set-window-size: (600, 600)
Expand Down
7 changes: 7 additions & 0 deletions tests/rustdoc-gui/src/proc_macro_test/Cargo.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,7 @@
# This file is automatically @generated by Cargo.
# It is not intended for manual editing.
version = 3

[[package]]
name = "proc_macro_test"
version = "0.1.0"
8 changes: 8 additions & 0 deletions tests/rustdoc-gui/src/proc_macro_test/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,8 @@
[package]
name = "proc_macro_test"
version = "0.1.0"
edition = "2021"

[lib]
path = "lib.rs"
proc-macro = true
11 changes: 11 additions & 0 deletions tests/rustdoc-gui/src/proc_macro_test/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,11 @@
use proc_macro::TokenStream;

#[proc_macro]
pub fn make_answer(_item: TokenStream) -> TokenStream {
"fn answer() -> u32 { 42 }".parse().unwrap()
}

#[proc_macro_derive(HelperAttr, attributes(helper))]
pub fn derive_helper_attr(_item: TokenStream) -> TokenStream {
TokenStream::new()
}
18 changes: 18 additions & 0 deletions tests/rustdoc-gui/src/test_docs/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,3 593,21 @@ pub mod foreign_impl_order {
fn f(&mut self, fg: [u8; 3]) {}
}
}

pub mod private {
pub struct Tuple(u32, u8);
pub struct Struct {
a: u8,
}

pub union Union {
a: u8,
b: u16,
}

pub enum Enum {
A,
#[doc(hidden)]
B,
}
}