Enum DocstringFormat 

pub enum DocstringFormat {
    PythonTripleQuote,
    JSDoc,
    Rustdoc,
    GoDoc,
    JavaDoc,
    Other(String),
}

The format of a docstring extracted from source code.

Identifies the docstring convention used, which varies by language (e.g., Python triple-quoted strings, JSDoc, Rustdoc /// comments).

Variants

PythonTripleQuote

JSDoc

Rustdoc

GoDoc

JavaDoc

Other(String)

Trait Implementations

impl Clone for DocstringFormat

fn clone(&self) -> DocstringFormat

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocstringFormat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocstringFormat

fn default() -> DocstringFormat

Returns the “default value” for a type.

impl Hash for DocstringFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for DocstringFormat

fn eq(&self, other: &DocstringFormat) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DocstringFormat

impl StructuralPartialEq for DocstringFormat