Skip to content

doc comments on extern blocks are ignored #77030

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Closed
lcnr opened this issue Sep 21, 2020 · 0 comments · Fixed by #94529
Closed

doc comments on extern blocks are ignored #77030

lcnr opened this issue Sep 21, 2020 · 0 comments · Fixed by #94529
Labels
A-lints Area: Lints (warnings about flaws in source code) such as unused_mut. C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@lcnr
Copy link
Contributor

lcnr commented Sep 21, 2020

For the following snippet

/// Hey
extern "C" {
    /// Ho
    pub fn test();
}

test is documented with Ho but Hey is nowhere to be found. It probably makes sense to error/warn if doc comments are used on extern blocks
@lcnr lcnr added A-lints Area: Lints (warnings about flaws in source code) such as unused_mut. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Sep 21, 2020
@jyn514 jyn514 added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-feature-request Category: A feature request, i.e: not implemented / a PR. and removed A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Sep 22, 2020
@GuillaumeGomez GuillaumeGomez mentioned this issue Mar 2, 2022
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 2, 2022
@matthiaskrgr
Rollup merge of rust-lang#94529 - GuillaumeGomez:unused-doc-comments-…
dc1a03b 
…blocks, r=estebank

Unused doc comments blocks

Fixes rust-lang#77030.
@bors bors closed this as completed in 878a4ff Mar 3, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
A-lints Area: Lints (warnings about flaws in source code) such as unused_mut. C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Unused doc comments blocks GuillaumeGomez/rust
3 participants
@Manishearth @jyn514 @lcnr