@@ -28,8 +28,8 @@ that's the high-level overview.
2828 CSS/JS and landing page are.
2929* Most of the HTML printing code is in ` html/format.rs ` and ` html/render.rs ` . It's in a bunch of
3030 ` fmt::Display ` implementations and supplementary functions.
31- * The types that operates on are defined in ` clean/mod.rs ` , right next to the custom ` Clean ` trait
32- used to process them out of the rustc HIR.
31+ * The types that got ` Display ` impls above are defined in ` clean/mod.rs ` , right next to the custom
32+ ` Clean ` trait used to process them out of the rustc HIR.
3333* The bits specific to using rustdoc as a test harness are in ` test.rs ` .
3434* The Markdown renderer is loaded up in ` html/markdown.rs ` , including functions for extracting
3535 doctests from a given block of Markdown.
@@ -68,10 +68,12 @@ and inlining. This is where `#[doc(inline)]`, `#[doc(no_inline)]`, and `#[doc(hi
6868processed, as well as the logic for whether a ` pub use ` should get the full page or a "Reexport"
6969line in the module page.
7070
71- Back in ` clean/mod.rs ` , the other major thing that happens here is the special collection of doc
72- comments (and basic ` #[doc=""] ` attributes) into a separate field in the ` Attributes ` struct from
73- the other attributes. The primary output of this process is a ` clean::Crate ` with a tree of ` Item ` s
74- which describe the publicly-documentable items in the target crate.
71+ The other major thing that happens in ` clean/mod.rs ` is the collection of doc comments and
72+ ` #[doc=""] ` attributes into a separate field of the Attributes struct, present on anything that gets
73+ hand-written documentation. This makes it easier to collect this documentation later in the process.
74+
75+ The primary output of this process is a clean::Crate with a tree of Items which describe the
76+ publicly-documentable items in the target crate.
7577
7678### Hot potato
7779
0 commit comments