Document private items for rustfmt

This is possible now that rustdoc allows passing
`--document-private-items` more than once.
This commit is contained in:
Joshua Nelson 2021-07-13 21:09:03 -04:00
parent 2bd17c1d43
commit 6216b4ece4
4 changed files with 7 additions and 16 deletions

View file

@ -619,7 +619,7 @@ impl Step for Rustc {
}
macro_rules! tool_doc {
($tool: ident, $should_run: literal, $path: literal, [$($krate: literal),+ $(,)?], binary=$bin:expr) => {
($tool: ident, $should_run: literal, $path: literal, [$($krate: literal),+ $(,)?] $(,)?) => {
#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
pub struct $tool {
stage: u32,
@ -688,9 +688,7 @@ macro_rules! tool_doc {
cargo.arg("-p").arg($krate);
)+
if !$bin {
cargo.rustdocflag("--document-private-items");
}
cargo.rustdocflag("--enable-index-page");
cargo.rustdocflag("--show-type-layout");
cargo.rustdocflag("-Zunstable-options");
@ -700,19 +698,12 @@ macro_rules! tool_doc {
}
}
tool_doc!(
Rustdoc,
"rustdoc-tool",
"src/tools/rustdoc",
["rustdoc", "rustdoc-json-types"],
binary = false
);
tool_doc!(Rustdoc, "rustdoc-tool", "src/tools/rustdoc", ["rustdoc", "rustdoc-json-types"]);
tool_doc!(
Rustfmt,
"rustfmt-nightly",
"src/tools/rustfmt",
["rustfmt-nightly", "rustfmt-config_proc_macro"],
binary = true
);
#[derive(Ord, PartialOrd, Debug, Copy, Clone, Hash, PartialEq, Eq)]

View file

@ -393,7 +393,7 @@ fn identify_comment(
}
/// Attributes for code blocks in rustdoc.
/// See https://doc.rust-lang.org/rustdoc/print.html#attributes
/// See <https://doc.rust-lang.org/rustdoc/print.html#attributes>.
enum CodeBlockAttribute {
Rust,
Ignore,

View file

@ -1417,7 +1417,7 @@ impl MacroBranch {
}
}
/// Format `lazy_static!` from https://crates.io/crates/lazy_static.
/// Format `lazy_static!` from <https://crates.io/crates/lazy_static>.
///
/// # Expected syntax
///

View file

@ -22,11 +22,11 @@ use crate::utils::{format_mutability, mk_sp, mk_sp_lo_plus_one, rewrite_ident};
/// Returns `true` if the given pattern is "short".
/// A short pattern is defined by the following grammar:
///
/// [small, ntp]:
/// `[small, ntp]`:
/// - single token
/// - `&[single-line, ntp]`
///
/// [small]:
/// `[small]`:
/// - `[small, ntp]`
/// - unary tuple constructor `([small, ntp])`
/// - `&[small]`