Skip to content

Commit

Permalink
Add test for impl blocks containing only private items
Browse files Browse the repository at this point in the history
  • Loading branch information
GuillaumeGomez committed Aug 9, 2022
1 parent dd816a9 commit c634852
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 0 deletions.
44 changes: 44 additions & 0 deletions src/test/rustdoc/empty-impl-block-private-with-doc.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
// compile-flags: --document-private-items

#![feature(inherent_associated_types)]
#![allow(incomplete_features)]
#![crate_name = "foo"]

// @has 'foo/struct.Foo.html'
pub struct Foo;

// There are 3 impl blocks with public item and one that should not be displayed
// by default because it only contains private items (but not in this case because
// we used `--document-private-items`).
// @count - '//*[@class="impl has-srclink"]' 'impl Foo' 4

// Impl block only containing private items should not be displayed unless the
// `--document-private-items` flag is used.
/// Private
impl Foo {
const BAR: u32 = 0;
type FOO = i32;
fn hello() {}
}

// But if any element of the impl block is public, it should be displayed.
/// Not private
impl Foo {
pub const BAR: u32 = 0;
type FOO = i32;
fn hello() {}
}

/// Not private
impl Foo {
const BAR: u32 = 0;
pub type FOO = i32;
fn hello() {}
}

/// Not private
impl Foo {
const BAR: u32 = 0;
type FOO = i32;
pub fn hello() {}
}
40 changes: 40 additions & 0 deletions src/test/rustdoc/empty-impl-block-private.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#![feature(inherent_associated_types)]
#![allow(incomplete_features)]
#![crate_name = "foo"]

// @has 'foo/struct.Foo.html'
pub struct Foo;

// There are 3 impl blocks with public item and one that should not be displayed
// because it only contains private items.
// @count - '//*[@class="impl has-srclink"]' 'impl Foo' 3

// Impl block only containing private items should not be displayed.
/// Private
impl Foo {
const BAR: u32 = 0;
type FOO = i32;
fn hello() {}
}

// But if any element of the impl block is public, it should be displayed.
/// Not private
impl Foo {
pub const BAR: u32 = 0;
type FOO = i32;
fn hello() {}
}

/// Not private
impl Foo {
const BAR: u32 = 0;
pub type FOO = i32;
fn hello() {}
}

/// Not private
impl Foo {
const BAR: u32 = 0;
type FOO = i32;
pub fn hello() {}
}

0 comments on commit c634852

Please sign in to comment.