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
mod util;
use schemars::JsonSchema;
use util::*;
#[derive(Debug, JsonSchema)]
/**
*
* # This is the struct's title
*
* This is the struct's description.
*
*/
pub struct MyStruct {
/// # An integer
pub my_int: i32,
pub my_undocumented_bool: bool,
/// A unit struct instance
pub my_unit: MyUnitStruct,
}
/// # A Unit
///
#[derive(Debug, JsonSchema)]
pub struct MyUnitStruct;
/// # This is the enum's title
/// This is
#[derive(Debug, JsonSchema)]
/// the enum's description.
pub enum MyEnum {
UndocumentedUnit,
/// This comment is not included in the generated schema :(
DocumentedUnit,
/// ## Complex variant
/// This is a struct-like variant.
Complex {
/// ### A nullable string
///
/// This field is a nullable string.
///
/// This
///is
/// the second
/// line!
///
///
///
///
/// And this is the third!
my_nullable_string: Option<String>,
},
}
#[test]
fn doc_comments_struct() -> TestResult {
test_default_generated_schema::<MyStruct>("doc_comments_struct")
}
#[test]
fn doc_comments_enum() -> TestResult {
test_default_generated_schema::<MyEnum>("doc_comments_enum")
}