serde-doc 0.1.0

A tool to generate documentation for Serde serialization and deserialization.
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57

use std::io::Write;

use crate::Context;

use super::{Generator, GeneratorConfig};
use anyhow::{Context as _, Result};


pub struct MarkdownGenerator {}

impl MarkdownGenerator {
    pub fn new() -> Self {
        MarkdownGenerator {}
    }
}


impl Generator for MarkdownGenerator {
    fn generate(&self, ctx: &Context, config: &GeneratorConfig) -> Result<()> {
        let mut content = String::new();
        // content.push_str(&format!("# {} Documentation\n", ctx.name));
        content.push_str("## Structs\n");
        for file_unit in &ctx.files {
            for struct_unit in &file_unit.structs { 

                content.push_str(&format!("### {}\n", struct_unit.name));

                if let Some(comment) = &struct_unit.doc {
                    content.push_str(&format!("{}\n", comment));
                }
                content.push_str("Fields:\n");
                for field in &struct_unit.fields {
                    content.push_str(&format!("- {}: {}\n", field.name, field.ty));
                    if let Some(comment) = &field.doc {
                        content.push_str(&format!("  - {}\n", comment));
                    }
                }
            }
        }

        match &config.output {
            Some(output) => {
              
                let mut file = std::fs::File::create(&output)?;

                file.write(content.as_bytes())
                    .with_context(|| format!("failed to write to file: {:?}", output))?;
                
            }
            None => {
                println!("{}", content);
            }
        }

        Ok(())
    }
}