| 1 | <section id="readme_main" class="doc-node"> |
| 2 | <div class="title"><h1> main <a href="#readme_main">#</a></h1></div> |
| 3 | <h2 id="description">Description</h2> |
| 4 | <p>This is an example of a an .md file, used for adding more rich text documentation in a project or module.</p> |
| 5 | <p>This is a <a href="https://vlang.io/">link</a> to the main V site.</p> |
| 6 | <p>This is a <b>bold text</b>.</p> |
| 7 | <p>This is a script <code><script>console.log('hi from README.md');</script></code> .</p> |
| 8 | <h2 id="examples">Examples</h2> |
| 9 | <h3 id="functions-that-return-different-literals">Functions that return different literals:</h3> |
| 10 | <p>Example of a function returning boolean:</p> |
| 11 | <pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">is_odd</span><span class="token punctuation">(</span>x <span class="token builtin">int</span><span class="token punctuation">)</span> <span class="token builtin">bool</span> <span class="token punctuation">{</span> |
| 12 | <span class="token keyword">if</span> x <span class="token operator">%</span> <span class="token number">2</span> <span class="token operator">==</span> <span class="token number">0</span> <span class="token punctuation">{</span> |
| 13 | <span class="token keyword">return</span> <span class="token boolean">false</span> |
| 14 | <span class="token punctuation">}</span> |
| 15 | <span class="token keyword">return</span> <span class="token boolean">true</span> |
| 16 | <span class="token punctuation">}</span></code></pre> |
| 17 | <p>Another example of a function returning a string:</p> |
| 18 | <pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">answer</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token builtin">string</span> <span class="token punctuation">{</span> |
| 19 | <span class="token keyword">return</span> <span class="token string">'42'</span> |
| 20 | <span class="token punctuation">}</span></code></pre> |
| 21 | <p>This example shows a function returning a string with interpolation:</p> |
| 22 | <pre><code class="language-v"><span class="token keyword">fn</span> <span class="token function">str_with_interplation</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token builtin">string</span> <span class="token punctuation">{</span> |
| 23 | <span class="token keyword">return</span><span class="token string"> 'this string has </span><span class="token string_interp">$</span>{<span class="token number">42</span><span class="token punctuation">:</span><span class="token number">6</span>}<span class="token string"> interpolation in it.'</span> |
| 24 | <span class="token punctuation">}</span></code></pre> |
| 25 | <h3 id="processing-command-line-args">Processing command line args</h3> |
| 26 | <pre><code class="language-v"><span class="token keyword">import</span> os |
| 27 | |
| 28 | <span class="token keyword">fn</span> <span class="token function">main</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> |
| 29 | <span class="token keyword">dump</span><span class="token punctuation">(</span>os<span class="token punctuation">.</span>args<span class="token punctuation">)</span> |
| 30 | <span class="token keyword">dump</span><span class="token punctuation">(</span>os<span class="token punctuation">.</span>args<span class="token punctuation">.</span>len<span class="token punctuation">)</span> |
| 31 | <span class="token keyword">assert</span> os<span class="token punctuation">.</span>args<span class="token punctuation">.</span>len <span class="token operator">></span> <span class="token number">0</span> |
| 32 | |
| 33 | <span class="token comment">// Test escape characters like for `&` and `<`</span> |
| 34 | <span class="token keyword">mut</span> arr <span class="token operator">:=</span> <span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token number">3</span><span class="token punctuation">]</span> |
| 35 | <span class="token keyword">mut</span> ref <span class="token operator">:=</span> <span class="token operator">&</span>arr |
| 36 | arr <span class="token operator"><<</span> <span class="token number">4</span> |
| 37 | |
| 38 | ch <span class="token operator">:=</span> <span class="token builtin">chan</span> <span class="token builtin">bool</span><span class="token punctuation">{</span>cap<span class="token punctuation">:</span> <span class="token number">1</span><span class="token punctuation">}</span> |
| 39 | ch <span class="token operator"><-</span> <span class="token boolean">true</span> |
| 40 | <span class="token punctuation">}</span></code></pre> |
| 41 | <h3 id="a-jwt-example-test-syntax-highlighting">A JWT example (test syntax highlighting)</h3> |
| 42 | <pre><code class="language-v"><span class="token keyword">import</span> crypto<span class="token punctuation">.</span>hmac |
| 43 | <span class="token keyword">import</span> crypto<span class="token punctuation">.</span>sha256 |
| 44 | <span class="token keyword">import</span> encoding<span class="token punctuation">.</span>base64 |
| 45 | <span class="token keyword">import</span> json |
| 46 | <span class="token keyword">import</span> time |
| 47 | |
| 48 | <span class="token keyword">struct</span> <span class="token symbol">JwtHeader</span> <span class="token punctuation">{</span> |
| 49 | alg <span class="token builtin">string</span> |
| 50 | typ <span class="token builtin">string</span> |
| 51 | <span class="token punctuation">}</span> |
| 52 | |
| 53 | <span class="token keyword">struct</span> <span class="token symbol">JwtPayload</span> <span class="token punctuation">{</span> |
| 54 | sub <span class="token builtin">string</span> |
| 55 | name <span class="token builtin">string</span> |
| 56 | iat <span class="token builtin">int</span> |
| 57 | <span class="token punctuation">}</span> |
| 58 | |
| 59 | <span class="token keyword">fn</span> <span class="token function">main</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> |
| 60 | sw <span class="token operator">:=</span> time<span class="token punctuation">.</span><span class="token function">new_stopwatch</span><span class="token punctuation">(</span><span class="token punctuation">)</span> |
| 61 | secret <span class="token operator">:=</span> <span class="token string">'your-256-bit-secret'</span> |
| 62 | token <span class="token operator">:=</span> <span class="token function">make_token</span><span class="token punctuation">(</span>secret<span class="token punctuation">)</span> |
| 63 | ok <span class="token operator">:=</span> <span class="token function">auth_verify</span><span class="token punctuation">(</span>secret<span class="token punctuation">,</span> token<span class="token punctuation">)</span> |
| 64 | dt <span class="token operator">:=</span> sw<span class="token punctuation">.</span><span class="token function">elapsed</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">microseconds</span><span class="token punctuation">(</span><span class="token punctuation">)</span> |
| 65 | <span class="token function">println</span><span class="token punctuation">(</span><span class="token string">'token: </span><span class="token string_interp">$</span>{token}<span class="token string">'</span><span class="token punctuation">)</span> |
| 66 | <span class="token function">println</span><span class="token punctuation">(</span><span class="token string">'auth_verify(secret, token): </span><span class="token string_interp">$</span>{ok}<span class="token string">'</span><span class="token punctuation">)</span> |
| 67 | <span class="token function">println</span><span class="token punctuation">(</span><span class="token string">'Elapsed time: </span><span class="token string_interp">$</span>{dt}<span class="token string"> uS'</span><span class="token punctuation">)</span> |
| 68 | <span class="token punctuation">}</span> |
| 69 | |
| 70 | <span class="token keyword">fn</span> <span class="token function">make_token</span><span class="token punctuation">(</span>secret <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token builtin">string</span> <span class="token punctuation">{</span> |
| 71 | header <span class="token operator">:=</span> base64<span class="token punctuation">.</span><span class="token function">url_encode</span><span class="token punctuation">(</span>json<span class="token punctuation">.</span><span class="token function">encode</span><span class="token punctuation">(</span><span class="token symbol">JwtHeader</span><span class="token punctuation">{</span><span class="token string">'HS256'</span><span class="token punctuation">,</span> <span class="token string">'JWT'</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> |
| 72 | payload <span class="token operator">:=</span> base64<span class="token punctuation">.</span><span class="token function">url_encode</span><span class="token punctuation">(</span>json<span class="token punctuation">.</span><span class="token function">encode</span><span class="token punctuation">(</span><span class="token symbol">JwtPayload</span><span class="token punctuation">{</span><span class="token string">'1234567890'</span><span class="token punctuation">,</span> <span class="token string">'John Doe'</span><span class="token punctuation">,</span> <span class="token number">1516239022</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> |
| 73 | signature <span class="token operator">:=</span> base64<span class="token punctuation">.</span><span class="token function">url_encode</span><span class="token punctuation">(</span>hmac<span class="token punctuation">.</span><span class="token function">new</span><span class="token punctuation">(</span>secret<span class="token punctuation">.</span><span class="token function">bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span><span class="token string">'</span><span class="token string_interp">$</span>{header}<span class="token string">.</span><span class="token string_interp">$</span>{payload}<span class="token string">'</span><span class="token punctuation">.</span><span class="token function">bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> |
| 74 | sha256<span class="token punctuation">.</span>sum<span class="token punctuation">,</span> sha256<span class="token punctuation">.</span>block_size<span class="token punctuation">)</span><span class="token punctuation">)</span> |
| 75 | jwt <span class="token operator">:=</span><span class="token string">'</span><span class="token string_interp">$</span>{header}<span class="token string">.</span><span class="token string_interp">$</span>{payload}<span class="token string">.</span><span class="token string_interp">$</span>{signature}<span class="token string">'</span> |
| 76 | <span class="token keyword">return</span> jwt |
| 77 | <span class="token punctuation">}</span> |
| 78 | |
| 79 | <span class="token keyword">fn</span> <span class="token function">auth_verify</span><span class="token punctuation">(</span>secret <span class="token builtin">string</span><span class="token punctuation">,</span> token <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token builtin">bool</span> <span class="token punctuation">{</span> |
| 80 | token_split <span class="token operator">:=</span> token<span class="token punctuation">.</span><span class="token function">split</span><span class="token punctuation">(</span><span class="token string">'.'</span><span class="token punctuation">)</span> |
| 81 | signature_mirror <span class="token operator">:=</span> hmac<span class="token punctuation">.</span><span class="token function">new</span><span class="token punctuation">(</span>secret<span class="token punctuation">.</span><span class="token function">bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span><span class="token string">'</span><span class="token string_interp">$</span>{token_split<span class="token punctuation">[</span><span class="token number">0</span><span class="token punctuation">]</span>}<span class="token string">.</span><span class="token string_interp">$</span>{token_split<span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">]</span>}<span class="token string">'</span><span class="token punctuation">.</span><span class="token function">bytes</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> |
| 82 | sha256<span class="token punctuation">.</span>sum<span class="token punctuation">,</span> sha256<span class="token punctuation">.</span>block_size<span class="token punctuation">)</span> |
| 83 | signature_from_token <span class="token operator">:=</span> base64<span class="token punctuation">.</span><span class="token function">url_decode</span><span class="token punctuation">(</span>token_split<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span><span class="token punctuation">)</span> |
| 84 | <span class="token keyword">return</span> hmac<span class="token punctuation">.</span><span class="token function">equal</span><span class="token punctuation">(</span>signature_from_token<span class="token punctuation">,</span> signature_mirror<span class="token punctuation">)</span> |
| 85 | <span class="token punctuation">}</span></code></pre> |
| 86 | <h3 id="other-language-specifiers">Other language specifiers</h3> |
| 87 | <pre><code class="language-cpp">## |
| 88 | std<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token builtin">map</span><span class="token operator"><</span>std<span class="token punctuation">:</span><span class="token punctuation">:</span><span class="token builtin">string</span><span class="token punctuation">,</span> <span class="token builtin">int</span><span class="token operator">></span> <span class="token symbol">my_map</span> <span class="token punctuation">{</span> |
| 89 | <span class="token punctuation">{</span><span class="token string">'KEY_1'</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">}</span><span class="token punctuation">,</span> |
| 90 | <span class="token punctuation">{</span><span class="token string">'KEY_2'</span><span class="token punctuation">,</span> <span class="token number">10</span><span class="token punctuation">}</span><span class="token punctuation">,</span> |
| 91 | <span class="token punctuation">}</span><span class="token punctuation">;</span> |
| 92 | |
| 93 | <span class="token keyword">for</span> <span class="token punctuation">(</span><span class="token keyword">const</span> auto <span class="token operator">&</span><span class="token punctuation">[</span>key<span class="token punctuation">,</span> value<span class="token punctuation">]</span> <span class="token punctuation">:</span> my_map<span class="token punctuation">)</span> <span class="token punctuation">{</span> |
| 94 | std<span class="token punctuation">:</span><span class="token punctuation">:</span>cout <span class="token operator"><<</span> key <span class="token operator"><<</span> <span class="token string">': '</span> <span class="token operator"><<</span> value <span class="token operator"><<</span> <span class="token string">', '</span><span class="token punctuation">;</span> |
| 95 | <span class="token punctuation">}</span> |
| 96 | std<span class="token punctuation">:</span><span class="token punctuation">:</span>cout <span class="token operator"><<</span> <span class="token string">'\n'</span><span class="token punctuation">;</span></code></pre> |
| 97 | <pre><code class="language-v">doc1 <span class="token operator">:=</span> toml<span class="token punctuation">.</span><span class="token function">parse_text</span><span class="token punctuation">(</span><span class="token operator"><</span><span class="token builtin">string</span> content<span class="token operator">></span><span class="token punctuation">)</span> <span class="token keyword">or</span> <span class="token punctuation">{</span> <span class="token function">panic</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span> <span class="token punctuation">}</span> |
| 98 | doc2 <span class="token operator">:=</span> toml<span class="token punctuation">.</span><span class="token function">parse_file</span><span class="token punctuation">(</span><span class="token operator"><</span>file path<span class="token operator">></span><span class="token punctuation">)</span> <span class="token keyword">or</span> <span class="token punctuation">{</span> <span class="token function">panic</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span> <span class="token punctuation">}</span></code></pre> |
| 99 | <h3 id="escape-html-in-strings">Escape html in strings</h3> |
| 100 | <pre><code class="language-v"><span class="token keyword">const</span> html <span class="token operator">=</span> <span class="token string">'<!DOCTYPE html> |
| 101 | <html lang="en"> |
| 102 | <head> |
| 103 | <style> |
| 104 | body { |
| 105 | background: linear-gradient(to right, #274060, #1B2845); |
| 106 | color: GhostWhite; |
| 107 | font-family: sans-serif; |
| 108 | text-align: center; |
| 109 | } |
| 110 | </style> |
| 111 | </head> |
| 112 | <body> |
| 113 | <h1>Your App Content!</h1> |
| 114 | <button onclick="callV()">Call V!</button> |
| 115 | </body> |
| 116 | <script> |
| 117 | async function callV() { |
| 118 | // Call a V function that takes an argument and returns a value. |
| 119 | const res = await window.my_v_func(\'Hello from JS!\'); |
| 120 | console.log(res); |
| 121 | } |
| 122 | </script> |
| 123 | </html>'</span></code></pre> |
| 124 | <ul> |
| 125 | <li>Regular markdown list point 1</li> |
| 126 | <li>List point 2</li> |
| 127 | <li>List point 3</li></ul> |
| 128 | <ol> |
| 129 | <li>Numbered markdown list point 1</li> |
| 130 | <li>List point 2</li> |
| 131 | <li>List point 3</li></ol> |
| 132 | <p>A code block without a specific language should be rendered verbatim:</p> |
| 133 | <pre><code>. |
| 134 | ├── static/ |
| 135 | │ ├── css/ |
| 136 | │ │ └── main.css |
| 137 | │ └── js/ |
| 138 | │ └── main.js |
| 139 | └── main.v |
| 140 | </code></pre> |
| 141 | <p>The s tags here in the code block, should be rendered verbatim, not interpreted as HTML ones:</p> |
| 142 | <pre><code>h:m:s // 5:02:33 |
| 143 | m:s.mi<s> // 2:33.015 |
| 144 | s.mi<s> // 33.015s |
| 145 | mi.mc<ms> // 15.007ms |
| 146 | mc.ns<ns> // 7.234us |
| 147 | ns<ns> // 234ns |
| 148 | </code></pre> |
| 149 | <p>The End.</p> |
| 150 | |
| 151 | </section> |
| 152 | |
| 153 | <section id="Constants" class="doc-node const"> |
| 154 | <div class="title"><h2>Constants <a href="#Constants">#</a></h2></div> |
| 155 | |
| 156 | |
| 157 | </section> |
| 158 | |
| 159 | <section id="" class="doc-node const"> |
| 160 | <pre class="signature"> |
| 161 | <code><span class="token keyword">const</span> omega <span class="token operator">=</span> <span class="token number">3</span> <span class="token comment">// should be first</span></code></pre> |
| 162 | |
| 163 | |
| 164 | </section> |
| 165 | |
| 166 | <section id="" class="doc-node const"> |
| 167 | <pre class="signature"> |
| 168 | <code><span class="token keyword">const</span> alpha <span class="token operator">=</span> <span class="token number">5</span> <span class="token comment">// should be in the middle</span></code></pre> |
| 169 | |
| 170 | |
| 171 | </section> |
| 172 | |
| 173 | <section id="" class="doc-node const"> |
| 174 | <pre class="signature"> |
| 175 | <code><span class="token keyword">const</span> beta <span class="token operator">=</span> <span class="token number">2</span> <span class="token comment">// should be at the end</span></code></pre> |
| 176 | |
| 177 | |
| 178 | </section> |
| 179 | |
| 180 | <section id="abc" class="doc-node"> |
| 181 | <div class="title"><h2>fn abc <a href="#abc">#</a></h2></div> |
| 182 | <pre class="signature"> |
| 183 | <code><span class="token keyword">fn</span> <span class="token function">abc</span><span class="token punctuation">(</span><span class="token punctuation">)</span></code></pre> |
| 184 | <p>abc - should be last</p> |
| 185 | |
| 186 | </section> |
| 187 | |
| 188 | <section id="def" class="doc-node"> |
| 189 | <div class="title"><h2>fn def <a href="#def">#</a></h2></div> |
| 190 | <pre class="signature"> |
| 191 | <code><span class="token keyword">fn</span> <span class="token function">def</span><span class="token punctuation">(</span><span class="token punctuation">)</span></code></pre> |
| 192 | <p>def - should be first</p> |
| 193 | |
| 194 | </section> |
| 195 | |
| 196 | <section id="xyz" class="doc-node"> |
| 197 | <div class="title"><h2>fn xyz <a href="#xyz">#</a></h2></div> |
| 198 | <pre class="signature"> |
| 199 | <code><span class="token keyword">fn</span> <span class="token function">xyz</span><span class="token punctuation">(</span><span class="token punctuation">)</span></code></pre> |
| 200 | <p>xyz - should be in the middle a small script <script>console.log('hello');</script> bold text <b>bold</b> end underlined text <u>underline</u> end a link <a href="https://github.com/vlang/v">main v repo</a></p> |
| 201 | |
| 202 | </section> |
| 203 | |
| 204 | <section id="MyXMLDocument.abc" class="doc-node"> |
| 205 | <div class="title"><h2>fn MyXMLDocument.abc <a href="#MyXMLDocument.abc">#</a></h2></div> |
| 206 | <pre class="signature"> |
| 207 | <code><span class="token keyword">fn</span> MyXMLDocument<span class="token punctuation">.</span><span class="token function">abc</span><span class="token punctuation">(</span>text <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token operator">?</span><span class="token punctuation">(</span><span class="token builtin">string</span><span class="token punctuation">,</span> <span class="token builtin">int</span><span class="token punctuation">)</span></code></pre> |
| 208 | <p>MyXMLDocument.abc does something too... I just do not know what.</p> |
| 209 | |
| 210 | </section> |
| 211 | |
| 212 | <section id="MyXMLDocument.from_file" class="doc-node"> |
| 213 | <div class="title"><h2>fn MyXMLDocument.from_file <a href="#MyXMLDocument.from_file">#</a></h2></div> |
| 214 | <pre class="signature"> |
| 215 | <code><span class="token keyword">fn</span> MyXMLDocument<span class="token punctuation">.</span><span class="token function">from_file</span><span class="token punctuation">(</span>path <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token operator">!</span>MyXMLDocument</code></pre> |
| 216 | <p>MyXMLDocument.from_text processes the file path, and returns an error</p> |
| 217 | |
| 218 | </section> |
| 219 | |
| 220 | <section id="MyXMLDocument.from_text" class="doc-node"> |
| 221 | <div class="title"><h2>fn MyXMLDocument.from_text <a href="#MyXMLDocument.from_text">#</a></h2></div> |
| 222 | <pre class="signature"> |
| 223 | <code><span class="token keyword">fn</span> MyXMLDocument<span class="token punctuation">.</span><span class="token function">from_text</span><span class="token punctuation">(</span>text <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token operator">?</span>MyXMLDocument</code></pre> |
| 224 | <p>MyXMLDocument.from_text processes text and produces none</p> |
| 225 | |
| 226 | </section> |
| 227 | |
| 228 | <section id="MyXMLDocument" class="doc-node"> |
| 229 | <div class="title"><h2>struct MyXMLDocument <a href="#MyXMLDocument">#</a></h2></div> |
| 230 | <pre class="signature"> |
| 231 | <code><span class="token keyword">struct</span> <span class="token symbol">MyXMLDocument</span> <span class="token punctuation">{</span> |
| 232 | path <span class="token builtin">string</span> |
| 233 | <span class="token punctuation">}</span></code></pre> |
| 234 | <p>MyXMLDocument is here just to test the different combinations of methods/output types</p> |
| 235 | |
| 236 | </section> |
| 237 | |
| 238 | <section id="MyXMLDocument.instance_from_file" class="doc-node"> |
| 239 | <div class="title"><h2>fn (MyXMLDocument) instance_from_file <a href="#MyXMLDocument.instance_from_file">#</a></h2></div> |
| 240 | <pre class="signature"> |
| 241 | <code><span class="token keyword">fn</span> <span class="token punctuation">(</span>x <span class="token operator">&</span>MyXMLDocument<span class="token punctuation">)</span> <span class="token function">instance_from_file</span><span class="token punctuation">(</span>path <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token operator">!</span>MyXMLDocument</code></pre> |
| 242 | <p>instance_from_file does stuff with path</p> |
| 243 | |
| 244 | </section> |
| 245 | |
| 246 | <section id="MyXMLDocument.instance_from_text" class="doc-node"> |
| 247 | <div class="title"><h2>fn (MyXMLDocument) instance_from_text <a href="#MyXMLDocument.instance_from_text">#</a></h2></div> |
| 248 | <pre class="signature"> |
| 249 | <code><span class="token keyword">fn</span> <span class="token punctuation">(</span>x <span class="token operator">&</span>MyXMLDocument<span class="token punctuation">)</span> <span class="token function">instance_from_text</span><span class="token punctuation">(</span>text <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token operator">?</span>MyXMLDocument</code></pre> |
| 250 | <p>instance_from_text does stuff with text</p> |
| 251 | |
| 252 | </section> |
| 253 | |
| 254 | <section id="MyXMLDocument.instance_abc" class="doc-node"> |
| 255 | <div class="title"><h2>fn (MyXMLDocument) instance_abc <a href="#MyXMLDocument.instance_abc">#</a></h2></div> |
| 256 | <pre class="signature"> |
| 257 | <code><span class="token keyword">fn</span> <span class="token punctuation">(</span>x <span class="token operator">&</span>MyXMLDocument<span class="token punctuation">)</span> <span class="token function">instance_abc</span><span class="token punctuation">(</span>text <span class="token builtin">string</span><span class="token punctuation">)</span> <span class="token operator">?</span><span class="token punctuation">(</span><span class="token builtin">string</span><span class="token punctuation">,</span> <span class="token builtin">int</span><span class="token punctuation">)</span></code></pre> |
| 258 | <p>instance_abc does stuff too</p> |
| 259 | |
| 260 | </section> |
| 261 | |
| 262 | <section id="MyXMLDocument.instance_void" class="doc-node"> |
| 263 | <div class="title"><h2>fn (MyXMLDocument) instance_void <a href="#MyXMLDocument.instance_void">#</a></h2></div> |
| 264 | <pre class="signature"> |
| 265 | <code><span class="token keyword">fn</span> <span class="token punctuation">(</span>x <span class="token operator">&</span>MyXMLDocument<span class="token punctuation">)</span> <span class="token function">instance_void</span><span class="token punctuation">(</span><span class="token punctuation">)</span></code></pre> |
| 266 | <p>instance_void does stuff too</p> |
| 267 | |
| 268 | </section> |
| 269 | |
| 270 | <section id="MyXMLDocument.instance_int" class="doc-node"> |
| 271 | <div class="title"><h2>fn (MyXMLDocument) instance_int <a href="#MyXMLDocument.instance_int">#</a></h2></div> |
| 272 | <pre class="signature"> |
| 273 | <code><span class="token keyword">fn</span> <span class="token punctuation">(</span>x <span class="token operator">&</span>MyXMLDocument<span class="token punctuation">)</span> <span class="token function">instance_int</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token builtin">int</span></code></pre> |
| 274 | <p>instance_int does stuff too</p> |
| 275 | |
| 276 | </section> |
| 277 | |
| 278 | <section id="MyXMLDocument.instance_result" class="doc-node"> |
| 279 | <div class="title"><h2>fn (MyXMLDocument) instance_result <a href="#MyXMLDocument.instance_result">#</a></h2></div> |
| 280 | <pre class="signature"> |
| 281 | <code><span class="token keyword">fn</span> <span class="token punctuation">(</span>x <span class="token operator">&</span>MyXMLDocument<span class="token punctuation">)</span> <span class="token function">instance_result</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">!</span></code></pre> |
| 282 | <p>instance_error does stuff too</p> |
| 283 | |
| 284 | </section> |
| 285 | |
| 286 | <section id="MyXMLDocument.instance_option" class="doc-node"> |
| 287 | <div class="title"><h2>fn (MyXMLDocument) instance_option <a href="#MyXMLDocument.instance_option">#</a></h2></div> |
| 288 | <pre class="signature"> |
| 289 | <code><span class="token keyword">fn</span> <span class="token punctuation">(</span>x <span class="token operator">&</span>MyXMLDocument<span class="token punctuation">)</span> <span class="token function">instance_option</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">?</span></code></pre> |
| 290 | <p>instance_option does stuff too</p> |
| 291 | |
| 292 | </section> |
| 293 | |