tfdoc 0.1.5

Generate Terraform module documentation
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

use std::fmt;

#[derive(Debug)]
pub struct DocItem {
    pub category: BlockType,
    pub name: String,
    pub description: Vec<String>,
}

impl DocItem {
    pub fn new() -> DocItem {
        DocItem {
            category: BlockType::None,
            name: String::new(),
            description: vec![],
        }
    }
}

impl fmt::Display for DocItem {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        if self.name.len() > 0 {
            write!(f, "`{}`: {}", self.name, self.description.join(" "))
        } else {
            write!(f, "{}", self.description.join(" "))
        }
    }
}

#[derive(Debug, PartialEq)]
pub enum BlockType {
    Comment,
    Resource,
    Output,
    Variable,
    None,
}