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
164
165
166
167
168
169

//! > Documentation submodules

//! > test_runner_name
documentation_test_runner

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

//! > cairo_code
//! This is a testing crate file. It's for the tests purposes only.
//! ```
//!   let a = 5;
//! ```
//! This is also testing crate. After the code example.

//! We don't take responsibility for compiling this file.
//! So don't even try.
//!
//! # Test markdown headings
//!
//! ## One after another
//!
//! ### ```fn code_can_be_heading()```
//!
//! #### [link can be heading](URL)

/// This one is just a prefix comment for a module.
/// ```rust
///   let a = String::from("This also works fine");
/// ```
/// As mentioned above.
mod cairo_submodule_code;

/// Main function.
/// Uses [cairo_submodule_code::inner_sub_module].
fn main() {
    //! Empty code example.
    //! ```rust
    //! ```
    println!("Hello Cairo!");
}

//! > cairo_submodule_code
//! This is a submodule regarding the module_level_comments.

//! It's used to make sure crate / module level comments are parsed in a correct way.
//! Testing purposes only!

/// [super::main]
mod inner_sub_module {
    //! This comment just proves that it won't be considered as a file-module comment. It just
    //! refers to the inner_sub_module
    /// Hello function inside the inner module.
    fn hello() {
        println!("Hello!");
    }
}

//! > Item signature #1

//! > Item documentation #1
This is a testing crate file. It's for the tests purposes only.
```cairo
  let a = 5;
```

This is also testing crate. After the code example.
We don't take responsibility for compiling this file.
So don't even try.
# Test markdown headings
## One after another
### `fn code_can_be_heading()`
#### [link can be heading](URL)

//! > Item documentation tokens #1
Content("This is a testing crate file. It's for the tests purposes only.")
Content("\n")
Content("```cairo\n")
Content("  let a = 5;\n")
Content("```\n")
Content("\n")
Content("This is also testing crate. After the code example.")
Content("\n")
Content("We don't take responsibility for compiling this file.")
Content("\n")
Content("So don't even try.")
Content("\n")
Content("# ")
Content("Test markdown headings")
Content("\n")
Content("## ")
Content("One after another")
Content("\n")
Content("### ")
Content("`fn code_can_be_heading()`")
Content("\n")
Content("#### ")
CommentLinkToken { label: "link can be heading", path: Some("URL"), md_link: MarkdownLink { link_span: TextSpan { start: TextOffset(TextWidth(300)), end: TextOffset(TextWidth(326)) }, dest_span: Some(TextSpan { start: TextOffset(TextWidth(322)), end: TextOffset(TextWidth(325)) }), dest_text: Some("URL") } }

//! > Item signature #2

//! > Item documentation #2
This is a submodule regarding the module_level_comments.
It's used to make sure crate / module level comments are parsed in a correct way.
Testing purposes only! This one is just a prefix comment for a module.
```rust
  let a = String::from("This also works fine");
```

As mentioned above.

//! > Item documentation tokens #2
Content("This is a submodule regarding the module_level_comments.")
Content("\n")
Content("It's used to make sure crate / module level comments are parsed in a correct way.")
Content("\n")
Content("Testing purposes only!")
Content(" ")
Content("This one is just a prefix comment for a module.")
Content("\n")
Content("```rust\n")
Content("  let a = String::from(\"This also works fine\");\n")
Content("```\n")
Content("\n")
Content("As mentioned above.")

//! > Item signature #3

//! > Item documentation #3
[super::main] This comment just proves that it won't be considered as a file-module comment. It just
refers to the inner_sub_module

//! > Item documentation tokens #3
CommentLinkToken { label: "super::main", path: None, md_link: MarkdownLink { link_span: TextSpan { start: TextOffset(TextWidth(0)), end: TextOffset(TextWidth(13)) }, dest_span: Some(TextSpan { start: TextOffset(TextWidth(1)), end: TextOffset(TextWidth(12)) }), dest_text: Some("super::main") } }
Content(" ")
Content("This comment just proves that it won't be considered as a file-module comment. It just")
Content("\n")
Content("refers to the inner_sub_module")

//! > Item signature #4
fn hello()

//! > Item documentation #4
Hello function inside the inner module.

//! > Item documentation tokens #4
Content("Hello function inside the inner module.")

//! > Item signature #5
fn main()

//! > Item documentation #5
Main function.
Uses [cairo_submodule_code::inner_sub_module]. Empty code example.
```rust
```

//! > Item documentation tokens #5
Content("Main function.")
Content("\n")
Content("Uses ")
CommentLinkToken { label: "cairo_submodule_code::inner_sub_module", path: None, md_link: MarkdownLink { link_span: TextSpan { start: TextOffset(TextWidth(20)), end: TextOffset(TextWidth(60)) }, dest_span: Some(TextSpan { start: TextOffset(TextWidth(21)), end: TextOffset(TextWidth(59)) }), dest_text: Some("cairo_submodule_code::inner_sub_module") } }
Content(".")
Content(" ")
Content("Empty code example.")
Content("\n")
Content("```rust\n")
Content("```")