Skip to content

rustdoc book: mention inner doc attribute #149720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jtracey wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

rustdoc book: mention inner doc attribute #149720

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/doc/rustdoc/src/write-documentation/the-doc-attribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading