mirror of
https://github.com/rust-lang/rust-analyzer
synced 2025-01-12 05:08:52 +00:00
4 lines
No EOL
17 KiB
HTML
4 lines
No EOL
17 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `HasDocComments` trait in crate `syntax`."><title>HasDocComments in syntax::ast - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="syntax" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../syntax/index.html">syntax</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">HasDoc<wbr>Comments</a></h2><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.doc_comments" title="doc_comments">doc_comments</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In syntax::<wbr>ast</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">syntax</a>::<wbr><a href="index.html">ast</a></span><h1>Trait <span class="trait">HasDocComments</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/syntax/ast/traits.rs.html#107-111">Source</a> </span></div><pre class="rust item-decl"><code>pub trait HasDocComments: <a class="trait" href="trait.HasAttrs.html" title="trait syntax::ast::HasAttrs">HasAttrs</a> {
|
|
// Provided method
|
|
fn <a href="#method.doc_comments" class="fn">doc_comments</a>(&self) -> <a class="struct" href="struct.DocCommentIter.html" title="struct syntax::ast::DocCommentIter">DocCommentIter</a> <a href="#" class="tooltip" data-notable-ty="DocCommentIter">ⓘ</a> { ... }
|
|
}</code></pre><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><section id="method.doc_comments" class="method"><a class="src rightside" href="../../src/syntax/ast/traits.rs.html#108-110">Source</a><h4 class="code-header">fn <a href="#method.doc_comments" class="fn">doc_comments</a>(&self) -> <a class="struct" href="struct.DocCommentIter.html" title="struct syntax::ast::DocCommentIter">DocCommentIter</a> <a href="#" class="tooltip" data-notable-ty="DocCommentIter">ⓘ</a></h4></section></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-HasDocComments-for-Adt" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#2269">Source</a><a href="#impl-HasDocComments-for-Adt" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="enum" href="enum.Adt.html" title="enum syntax::ast::Adt">Adt</a></h3></section><section id="impl-HasDocComments-for-AssocItem" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#2297">Source</a><a href="#impl-HasDocComments-for-AssocItem" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="enum" href="enum.AssocItem.html" title="enum syntax::ast::AssocItem">AssocItem</a></h3></section><section id="impl-HasDocComments-for-ExternItem" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#2347">Source</a><a href="#impl-HasDocComments-for-ExternItem" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="enum" href="enum.ExternItem.html" title="enum syntax::ast::ExternItem">ExternItem</a></h3></section><section id="impl-HasDocComments-for-Item" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#2392">Source</a><a href="#impl-HasDocComments-for-Item" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="enum" href="enum.Item.html" title="enum syntax::ast::Item">Item</a></h3></section><section id="impl-HasDocComments-for-AnyHasDocComments" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#2461">Source</a><a href="#impl-HasDocComments-for-AnyHasDocComments" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.AnyHasDocComments.html" title="struct syntax::ast::AnyHasDocComments">AnyHasDocComments</a></h3></section><section id="impl-HasDocComments-for-Const" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#466">Source</a><a href="#impl-HasDocComments-for-Const" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Const.html" title="struct syntax::ast::Const">Const</a></h3></section><section id="impl-HasDocComments-for-Enum" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#555">Source</a><a href="#impl-HasDocComments-for-Enum" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Enum.html" title="struct syntax::ast::Enum">Enum</a></h3></section><section id="impl-HasDocComments-for-ExternBlock" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#582">Source</a><a href="#impl-HasDocComments-for-ExternBlock" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.ExternBlock.html" title="struct syntax::ast::ExternBlock">ExternBlock</a></h3></section><section id="impl-HasDocComments-for-ExternCrate" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#597">Source</a><a href="#impl-HasDocComments-for-ExternCrate" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.ExternCrate.html" title="struct syntax::ast::ExternCrate">ExternCrate</a></h3></section><section id="impl-HasDocComments-for-Fn" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#645">Source</a><a href="#impl-HasDocComments-for-Fn" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Fn.html" title="struct syntax::ast::Fn">Fn</a></h3></section><section id="impl-HasDocComments-for-Impl" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#820">Source</a><a href="#impl-HasDocComments-for-Impl" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Impl.html" title="struct syntax::ast::Impl">Impl</a></h3></section><section id="impl-HasDocComments-for-MacroCall" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1012">Source</a><a href="#impl-HasDocComments-for-MacroCall" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.MacroCall.html" title="struct syntax::ast::MacroCall">MacroCall</a></h3></section><section id="impl-HasDocComments-for-MacroDef" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1029">Source</a><a href="#impl-HasDocComments-for-MacroDef" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.MacroDef.html" title="struct syntax::ast::MacroDef">MacroDef</a></h3></section><section id="impl-HasDocComments-for-MacroRules" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1067">Source</a><a href="#impl-HasDocComments-for-MacroRules" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.MacroRules.html" title="struct syntax::ast::MacroRules">MacroRules</a></h3></section><section id="impl-HasDocComments-for-Module" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1198">Source</a><a href="#impl-HasDocComments-for-Module" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Module.html" title="struct syntax::ast::Module">Module</a></h3></section><section id="impl-HasDocComments-for-RecordField" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1537">Source</a><a href="#impl-HasDocComments-for-RecordField" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.RecordField.html" title="struct syntax::ast::RecordField">RecordField</a></h3></section><section id="impl-HasDocComments-for-SourceFile" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1756">Source</a><a href="#impl-HasDocComments-for-SourceFile" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.SourceFile.html" title="struct syntax::ast::SourceFile">SourceFile</a></h3></section><section id="impl-HasDocComments-for-Static" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1768">Source</a><a href="#impl-HasDocComments-for-Static" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Static.html" title="struct syntax::ast::Static">Static</a></h3></section><section id="impl-HasDocComments-for-Struct" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1811">Source</a><a href="#impl-HasDocComments-for-Struct" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Struct.html" title="struct syntax::ast::Struct">Struct</a></h3></section><section id="impl-HasDocComments-for-Trait" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1848">Source</a><a href="#impl-HasDocComments-for-Trait" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Trait.html" title="struct syntax::ast::Trait">Trait</a></h3></section><section id="impl-HasDocComments-for-TraitAlias" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1869">Source</a><a href="#impl-HasDocComments-for-TraitAlias" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.TraitAlias.html" title="struct syntax::ast::TraitAlias">TraitAlias</a></h3></section><section id="impl-HasDocComments-for-TupleField" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1915">Source</a><a href="#impl-HasDocComments-for-TupleField" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.TupleField.html" title="struct syntax::ast::TupleField">TupleField</a></h3></section><section id="impl-HasDocComments-for-TypeAlias" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#1981">Source</a><a href="#impl-HasDocComments-for-TypeAlias" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.TypeAlias.html" title="struct syntax::ast::TypeAlias">TypeAlias</a></h3></section><section id="impl-HasDocComments-for-Union" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#2071">Source</a><a href="#impl-HasDocComments-for-Union" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Union.html" title="struct syntax::ast::Union">Union</a></h3></section><section id="impl-HasDocComments-for-Use" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#2087">Source</a><a href="#impl-HasDocComments-for-Use" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Use.html" title="struct syntax::ast::Use">Use</a></h3></section><section id="impl-HasDocComments-for-Variant" class="impl"><a class="src rightside" href="../../src/syntax/ast/generated/nodes.rs.html#2148">Source</a><a href="#impl-HasDocComments-for-Variant" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.HasDocComments.html" title="trait syntax::ast::HasDocComments">HasDocComments</a> for <a class="struct" href="struct.Variant.html" title="struct syntax::ast::Variant">Variant</a></h3></section></div><script src="../../trait.impl/syntax/ast/traits/trait.HasDocComments.js" async></script><script type="text/json" id="notable-traits-data">{"DocCommentIter":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.DocCommentIter.html\" title=\"struct syntax::ast::DocCommentIter\">DocCommentIter</a></code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.DocCommentIter.html\" title=\"struct syntax::ast::DocCommentIter\">DocCommentIter</a></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"struct\" href=\"struct.Comment.html\" title=\"struct syntax::ast::Comment\">Comment</a>;</div>"}</script></section></div></main></body></html> |