Struct KDoc

pub struct KDoc { /* private fields */ }

Represents a Kotlin documentation comment in KDoc format.

Entities that support KDoc should usually store it as singular instance and merge multiple KDocs into one.

Implementations

impl KDoc

pub fn new() -> KDoc

Creates new, empty KDoc

pub fn append(self, content: &str) -> KDoc

Appends content to the KDoc.

pub fn merge(self, other: KDoc) -> KDoc

Merges contents of [other] into [self]. Adds new line between contents.

Trait Implementations

impl Clone for KDoc

fn clone(&self) -> KDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KDoc

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

Formats the value using the given formatter.

impl From<&str> for KDoc

fn from(value: &str) -> Self

Converts to this type from the input type.

impl RenderKotlin for KDoc

fn render_into(&self, block: &mut CodeBlock)

Renders Kotlin code into CodeBlock.

fn render_string(&self) -> String

Shortcut method for converting RenderKotlin::render_into output into String.