cairo-lang-doc 2.18.0

A collection of documentation processing utilities for the Cairo programming language.
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
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! > Documentation

//! > test_runner_name
documentation_test_runner

//! > cairo_project.toml
[crate_roots]
hello = "src"

//! > cairo_code
struct MemberStruct {
    ty: MemberEnum,
}

enum MemberEnum {
    Simple: felt252,
    Complex: Span<MemberStruct>,
}

trait ATrait {}

struct B<T, G, +ATrait> {
    t: T,
    g: G,
}

fn function_tuple(t: (MemberStruct, (MemberStruct, MemberEnum))) -> (MemberStruct, MemberEnum) {
    return t;
}

enum AnotherEnum {
    Simple: felt252,
    Complex: (MemberStruct, MemberEnum),
}

fn incorrect_function(x: NotExistingType)

enum IncorrectEnum {
    INCORRECT_VARIANT: NotExistingType
}

struct IncorrectStruct {
    incorrect_member: NotExistingType,
}

trait Test<impl T: Copy<felt252>> {}

//! > Item signature #1
struct MemberStruct {
    ty: MemberEnum,
}

//! > Item linked items #1
MemberEnum

//! > Item signature #2
ty: MemberEnum

//! > Item linked items #2
MemberEnum

//! > Item signature #3
enum MemberEnum {
    Simple: felt252,
    Complex: Span<MemberStruct>,
}

//! > Item linked items #3

//! > Item signature #4
Simple: felt252

//! > Item linked items #4

//! > Item signature #5
Complex: Span<MemberStruct>

//! > Item linked items #5

//! > Item signature #6
trait ATrait

//! > Item linked items #6

//! > Item signature #7
struct B<T, G, +ATrait> {
    t: T,
    g: G,
}

//! > Item linked items #7
+ATrait

//! > Item signature #8
t: T

//! > Item linked items #8

//! > Item signature #9
g: G

//! > Item linked items #9

//! > Item signature #10
fn function_tuple(t: (MemberStruct, (MemberStruct, MemberEnum))) -> (MemberStruct, MemberEnum)

//! > Item linked items #10
MemberStruct, MemberStruct, MemberEnum, MemberStruct, MemberEnum

//! > Item signature #11
enum AnotherEnum {
    Simple: felt252,
    Complex: (MemberStruct, MemberEnum),
}

//! > Item linked items #11
MemberStruct, MemberEnum

//! > Item signature #12
Simple: felt252

//! > Item linked items #12

//! > Item signature #13
Complex: (MemberStruct, MemberEnum)

//! > Item linked items #13
MemberStruct, MemberEnum

//! > Item signature #14
fn incorrect_function(x: NotExistingType)

//! > Item linked items #14

//! > Item signature #15
enum IncorrectEnum {
    INCORRECT_VARIANT: <missing>,
}

//! > Item linked items #15

//! > Item signature #16
INCORRECT_VARIANT: <missing>

//! > Item linked items #16

//! > Item signature #17
struct IncorrectStruct {
    incorrect_member: <missing>,
}

//! > Item linked items #17

//! > Item signature #18
incorrect_member: <missing>

//! > Item linked items #18

//! > Item signature #19
trait Test<impl T: Copy<felt252>>

//! > Item linked items #19
Copy