Skip to main content

DocComment

Struct DocComment 

Source
pub struct DocComment {
    pub docs: Vec<String>,
}
Expand description

Represents a documentation comment in C code, using the /// style syntax.

Documentation comments are special comments typically placed before function declarations, struct definitions, typedefs, and other code elements to document their purpose, parameters, return values, and other important information.

§Usage

Doc comments are typically used to document:

  • Function signatures (parameters, return values, exceptions)
  • Data structures and their fields
  • Global variables and constants
  • Type definitions
  • File/module purpose

§Example

/// Calculates the square of a number
///
/// @param value The input number to square
/// @return The square of the input value
int square(int value);

Fields§

§docs: Vec<String>

Lines of documentation comment text. Each line will be prefixed with /// during formatting.

Implementations§

Source§

impl DocComment

Source

pub fn new() -> DocCommentBuilder

Creates and returns a new DocCommentBuilder to construct a DocComment using the builder pattern.

This method is the recommended entry point for creating documentation comments as it provides a fluent API for building multi-line documentation.

§Example
let doc_comment = DocComment::new()
    .line_str("Calculates the factorial of a number")
    .line_str("")
    .line_str("@param n The input number")
    .line_str("@return The factorial of n")
    .build();

Trait Implementations§

Source§

impl Clone for DocComment

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocComment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for DocComment

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Format for DocComment

Source§

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.