internal: Include private definitions in generated rustdoc

rust-analyzer has handy prebuilt `cargo doc` output at
https://rust-lang.github.io/rust-analyzer/ide/

However, it doesn't include private definitions, which makes it less
useful when trying to learn unfamiliar parts of the codebase.

Instead, pass `--document-private-items` so the HTML includes
information on private types and modules too. rustdoc renders these
with a padlock icon, so it's still clear that they're private.

This change also exposes some more rustdoc warnings, which I've fixed.
This commit is contained in:
Wilfred Hughes
2026-01-09 11:58:16 +00:00
parent 36a2b8fd73
commit 9c0d88cc07
21 changed files with 32 additions and 28 deletions

View File

@@ -1,6 +1,6 @@
//! Maps syntax elements through disjoint syntax nodes.
//!
//! [`SyntaxMappingBuilder`] should be used to create mappings to add to a [`SyntaxEditor`]
//! [`SyntaxMappingBuilder`] should be used to create mappings to add to a `SyntaxEditor`
use itertools::Itertools;
use rustc_hash::FxHashMap;