user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

rustdoc book: mention inner doc attribute

Browse source
This commit is contained in:
Justin Tracey 2025-12-06 11:16:14 -05:00 • committed by GitHub
parent ba86c0460b
commit a3a041da11
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
View file

@ -4,8 +4,8 @@ The `#[doc]` attribute lets you control various aspects of how `rustdoc` does
its job.
The most basic function of `#[doc]` is to handle the actual documentation
text. That is, `///` is syntax sugar for `#[doc]`. This means that these two
are the same:
text. That is, `///` is syntax sugar for `#[doc]` (as is `//!` for `#![doc]`).
This means that these two are the same:
```rust,no_run
/// This is a doc comment.