Struct DocComment 

pub struct DocComment {
    pub summary: String,
    pub description: Option<String>,
    pub examples: Vec<String>,
    pub sections: Vec<DocSection>,
}

ドキュメントコメント

Fields

summary: String

メインの説明文

description: Option<String>

詳細な説明

examples: Vec<String>

@example セクション

sections: Vec<DocSection>

その他のセクション

Implementations

impl DocComment

pub fn empty() -> DocComment

空のドキュメントコメント

pub fn summary(text: impl Into<String>) -> DocComment

単純なサマリーのみのドキュメント

pub fn parse(doc: &str) -> DocComment

Rustのdocコメントからパース

pub fn to_jsdoc(&self) -> String

JSDoc形式に変換

pub fn to_inline_jsdoc(&self) -> String

単一行JSDocコメント

Trait Implementations

impl Clone for DocComment

fn clone(&self) -> DocComment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocComment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocComment

fn deserialize<__D>( __deserializer: __D, ) -> Result<DocComment, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocComment

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.