diff options
| author | bors <bors@rust-lang.org> | 2021-08-30 05:23:54 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2021-08-30 05:23:54 +0000 |
| commit | dbb0fe9d803f7fa8688b33306266a6b054c2c3f4 (patch) | |
| tree | 1b6091c24eb6f6ce11ec9c4d00b253f070ab9d96 | |
| parent | 9556d7a09a7e80e84430071b29d118f39dde8205 (diff) | |
| parent | 6aacbd87f4b9a5f0472c1b8c63414a0044b50bfd (diff) | |
| download | rust-dbb0fe9d803f7fa8688b33306266a6b054c2c3f4.tar.gz rust-dbb0fe9d803f7fa8688b33306266a6b054c2c3f4.zip | |
Auto merge of #88456 - inquisitivecrystal:private-macro, r=jyn514
Fix: don't document private macros by default As part of #88019, I made it so private macros are documented in `--document-private-items` mode. Unfortunately, it appears that I also accidentally made them be documented when *not* in `--document-private-items` mode. This PR fixes that and adds a regression test. r? `@jyn514` (I hope you don't mind that I keep sending PRs your way) Fixes #88453.
| -rw-r--r-- | src/librustdoc/passes/stripper.rs | 5 | ||||
| -rw-r--r-- | src/test/rustdoc/macro-private-not-documented.rs | 19 |
2 files changed, 22 insertions, 2 deletions
diff --git a/src/librustdoc/passes/stripper.rs b/src/librustdoc/passes/stripper.rs index 4305268c9aa..819d7d323fd 100644 --- a/src/librustdoc/passes/stripper.rs +++ b/src/librustdoc/passes/stripper.rs @@ -40,6 +40,7 @@ impl<'a> DocFolder for Stripper<'a> { | clean::UnionItem(..) | clean::AssocConstItem(..) | clean::TraitAliasItem(..) + | clean::MacroItem(..) | clean::ForeignTypeItem => { if i.def_id.is_local() { if !self.access_levels.is_exported(i.def_id.expect_def_id()) { @@ -70,8 +71,8 @@ impl<'a> DocFolder for Stripper<'a> { clean::ImplItem(..) => {} - // tymethods/macros have no control over privacy - clean::MacroItem(..) | clean::TyMethodItem(..) => {} + // tymethods have no control over privacy + clean::TyMethodItem(..) => {} // Proc-macros are always public clean::ProcMacroItem(..) => {} diff --git a/src/test/rustdoc/macro-private-not-documented.rs b/src/test/rustdoc/macro-private-not-documented.rs new file mode 100644 index 00000000000..ae8b0e7229f --- /dev/null +++ b/src/test/rustdoc/macro-private-not-documented.rs @@ -0,0 +1,19 @@ +// Checks that private macros aren't documented by default. They +// should be still be documented in `--document-private-items` mode, +// but that's tested in `macro-document-private.rs`. +// +// +// This is a regression text for issue #88453. +#![feature(decl_macro)] + +// @!has macro_private_not_documented/index.html 'a_macro' +// @!has macro_private_not_documented/macro.a_macro.html +macro_rules! a_macro { + () => () +} + +// @!has macro_private_not_documented/index.html 'another_macro' +// @!has macro_private_not_documented/macro.another_macro.html +macro another_macro { + () => () +} |