Enum CommentStyle 

pub enum CommentStyle {
    JsDoc,
    PyDocstring,
    RustDoc,
    RustModuleDoc,
    GoDoc,
    Javadoc,
}

@acp:summary “Comment style for different languages”

Variants

JsDoc

JSDoc: /** … */

PyDocstring

Python docstring: “”“…”“”

RustDoc

Rust doc: ///

RustModuleDoc

Rust module doc: //!

GoDoc

Go: //

Javadoc

Javadoc: /** … */

Implementations

impl CommentStyle

pub fn from_language(language: &str, is_module_level: bool) -> Self

@acp:summary “Determines comment style from language and context”

pub fn format_annotations( &self, annotations: &[Suggestion], indent: &str, ) -> String

@acp:summary “Formats annotations into a comment block”

pub fn format_for_insertion( &self, annotations: &[Suggestion], indent: &str, ) -> Vec<String>

@acp:summary “Formats annotations for insertion into existing doc comment” Places ACP annotations at the beginning of the comment.

pub fn format_annotations_with_provenance( &self, annotations: &[Suggestion], indent: &str, config: &ProvenanceConfig, ) -> String

@acp:summary “Formats annotations with RFC-0003 provenance markers”

pub fn format_for_insertion_with_provenance( &self, annotations: &[Suggestion], indent: &str, config: &ProvenanceConfig, ) -> Vec<String>

@acp:summary “Formats annotations for insertion with RFC-0003 provenance markers”

Trait Implementations

impl Clone for CommentStyle

fn clone(&self) -> CommentStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommentStyle

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

Formats the value using the given formatter.

impl PartialEq for CommentStyle

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

impl Eq for CommentStyle

impl StructuralPartialEq for CommentStyle