pub struct DocCommentConfig {
pub line_prefixes: &'static [&'static str],
pub block_open: Option<&'static str>,
pub block_close: &'static str,
pub strip_continuation_marker: bool,
}Expand description
Configuration for extracting doc comments from source code.
Used for languages where doc comments are tree-sitter extras (siblings of declarations, not children) and cannot be captured inline in queries.
Fields§
§line_prefixes: &'static [&'static str]Line comment prefixes that indicate doc comments (e.g., ["///", "//!"] for Rust).
block_open: Option<&'static str>Block comment opening (e.g., Some("/**") for doxygen/JSDoc).
block_close: &'static strBlock comment closing (e.g., "*/").
strip_continuation_marker: boolWhether to strip leading * continuation markers in block comments.
Trait Implementations§
Source§impl Clone for DocCommentConfig
impl Clone for DocCommentConfig
Source§fn clone(&self) -> DocCommentConfig
fn clone(&self) -> DocCommentConfig
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for DocCommentConfig
impl RefUnwindSafe for DocCommentConfig
impl Send for DocCommentConfig
impl Sync for DocCommentConfig
impl Unpin for DocCommentConfig
impl UnsafeUnpin for DocCommentConfig
impl UnwindSafe for DocCommentConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more