neo-devpack-solidity 0.22.0

Production-focused Solidity-to-NeoVM compilation system
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Documentation Generator
//!
//! Generates API documentation from source code.

/// Documentation item
#[derive(Debug, Clone)]
pub struct DocItem {
    pub name: String,
    pub kind: DocKind,
    pub description: String,
    pub params: Vec<DocParam>,
    pub returns: Option<String>,
}

/// Documentation kind
#[derive(Debug, Clone, Copy)]
pub enum DocKind {
    Contract,
    Function,
    Event,
    Modifier,
    Variable,
}

/// Parameter documentation
#[derive(Debug, Clone)]
pub struct DocParam {
    pub name: String,
    pub type_name: String,
    pub description: String,
}

impl DocItem {
    pub fn new(name: impl Into<String>, kind: DocKind) -> Self {
        Self {
            name: name.into(),
            kind,
            description: String::new(),
            params: Vec::new(),
            returns: None,
        }
    }
}