Enum DocTarget 

pub enum DocTarget {
    PhpDoc,
    JavaDoc,
    TsDoc,
    JsDoc,
    CSharpDoc,
}

Target language for sanitize_rust_idioms.

Each variant selects the idiomatic mapping for Rust constructs that do not translate directly to foreign-language doc syntax.

Variants

PhpDoc

PHPDoc (/** ... */), e.g. phpstan-typed prose.

JavaDoc

Javadoc (/** ... */), e.g. OpenJDK-style annotations.

TsDoc

TSDoc (/** ... */), TypeScript variant of JSDoc.

JsDoc

JSDoc (/** ... */), JavaScript variant.

CSharpDoc

C# XML doc (/// <summary>...</summary>).

Strips Rust code fences and section headings (# Examples, # Arguments, # Returns, etc.), drops Rust trait-bound prose, and XML-escapes any remaining < / > / & so the result is safe to embed inside a <summary> element.

Trait Implementations

impl Clone for DocTarget

fn clone(&self) -> DocTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocTarget

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

Formats the value using the given formatter.

impl PartialEq for DocTarget

fn eq(&self, other: &DocTarget) -> 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 Copy for DocTarget

impl Eq for DocTarget

impl StructuralPartialEq for DocTarget