Mirrors/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-05-29 20:46:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

Improve Attribute doc methods

Browse Source
This commit is contained in:
Guillaume Gomez
2022-09-12 21:18:59 +02:00
committed by GitHub
parent 52e003a6e9
commit c4559ebfde
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
compiler/rustc_ast/src/attr/mod.rs
+11 -1
View File
@@ -233,7 +233,8 @@ pub fn meta_kind(&self) -> Option<MetaItemKind> {
impl Attribute {
/// Returns `true` if it is a sugared doc comment (`///` or `//!` for example).
/// So `#[doc = "doc"]` will return `false`.
/// So `#[doc = "doc"]` (which is a doc comment) and `#[doc(...)]` (which is not
/// a doc comment) will return `false`.
pub fn is_doc_comment(&self) -> bool {
match self.kind {
AttrKind::Normal(..) => false,
@@ -241,6 +242,11 @@ pub fn is_doc_comment(&self) -> bool {
}
}
/// Returns the documentation and its kind if this is a doc comment or a sugared doc comment.
/// * `///doc` returns `Some(("doc", CommentKind::Line))`.
/// * `/** doc */` returns `Some(("doc", CommentKind::Block))`.
/// * `#[doc = "doc"]` returns `Some(("doc", CommentKind::Line))`.
/// * `#[doc(...)]` returns `None`.
pub fn doc_str_and_comment_kind(&self) -> Option<(Symbol, CommentKind)> {
match self.kind {
AttrKind::DocComment(kind, data) => Some((data, kind)),
@@ -253,6 +259,10 @@ pub fn doc_str_and_comment_kind(&self) -> Option<(Symbol, CommentKind)> {
}
}
/// Returns the documentation if this is a doc comment or a sugared doc comment.
/// * `///doc` returns `Some("doc")`.
/// * `#[doc = "doc"]` returns `Some("doc")`.
/// * `#[doc(...)]` returns `None`.
pub fn doc_str(&self) -> Option<Symbol> {
match self.kind {
AttrKind::DocComment(.., data) => Some(data),