Struct spdcp::Comment

pub struct Comment {
    pub brief: String,
    pub tags: Vec<Tag>,
}

Fields

brief: String

Brief description of the function purpose

tags: Vec<Tag>

Tags of the symbol

Methods

impl Comment

pub fn parse<T>(data: T) -> Comment where
    T: Into<String>, 

Parse the comment into data structures

Example

use std::fs;
use spdcp::Comment;
 
fn main() {
    // Read the comment block from a data source
    let data = fs::read_to_string("data/comment_block.txt").expect("Unable to read file");
 
    let parsed = Comment::parse(data);
 
    println!("{:?}", parsed);
}

Trait Implementations

impl Clone for Comment

fn clone(&self) -> Comment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Comment

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

Formats the value using the given formatter.

impl PartialEq<Comment> for Comment

fn eq(&self, other: &Comment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Comment) -> bool

This method tests for !=.

impl StructuralPartialEq for Comment