unreal-doc 1.0.9

Tool for generating documentation from Unreal C++ sources.
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use serde::{Deserialize, Serialize};
use std::path::PathBuf;

#[derive(Debug, Default, Copy, Clone, PartialEq, Serialize, Deserialize)]
pub enum Backend {
    #[default]
    Json,
    MdBook,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct BackendMdBook {
    #[serde(default = "BackendMdBook::default_title")]
    pub title: String,
    #[serde(default)]
    pub authors: Vec<String>,
    #[serde(default = "BackendMdBook::default_language")]
    pub language: String,
    #[serde(default)]
    pub multilingual: bool,
    #[serde(default)]
    pub build: bool,
    #[serde(default)]
    pub cleanup: bool,
    #[serde(default)]
    pub header: Option<PathBuf>,
    #[serde(default)]
    pub footer: Option<PathBuf>,
    #[serde(default)]
    pub assets: Option<PathBuf>,
    #[serde(default)]
    pub site_url: Option<String>,
}

impl Default for BackendMdBook {
    fn default() -> Self {
        Self {
            title: Self::default_title(),
            authors: vec![],
            language: Self::default_language(),
            multilingual: false,
            build: false,
            cleanup: false,
            header: None,
            footer: None,
            assets: None,
            site_url: None,
        }
    }
}

impl BackendMdBook {
    fn default_title() -> String {
        "Documentation".to_owned()
    }

    fn default_language() -> String {
        "en".to_owned()
    }
}

#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct Config {
    #[serde(default)]
    pub dependencies: Vec<PathBuf>,
    pub input_dirs: Vec<PathBuf>,
    pub output_dir: PathBuf,
    #[serde(default)]
    pub backend: Backend,
    #[serde(default)]
    pub settings: Settings,
    pub backend_mdbook: Option<BackendMdBook>,
}

#[derive(Debug, Default, Clone, Serialize, Deserialize)]
pub struct Settings {
    #[serde(default)]
    pub show_all: bool,
    #[serde(default)]
    pub document_protected: bool,
    #[serde(default)]
    pub document_private: bool,
}