Skip to content

Commit eefc0d4

Browse files
lefticuslefticus
committed
Create links to generated doxygen documentation
1 parent b7ea5d2 commit eefc0d4

3,749 files changed

Lines changed: 269640 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/4/_lang_getting_started.html‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.4"/>
7+
<title>ChaiScript: ChaiScript Language Getting Started</title>
8+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9+
<script type="text/javascript" src="jquery.js"></script>
10+
<script type="text/javascript" src="dynsections.js"></script>
11+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
12+
<script type="text/javascript" src="search/search.js"></script>
13+
<script type="text/javascript">
14+
$(document).ready(function() { searchBox.OnSelectItem(0); });
15+
</script>
16+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
17+
</head>
18+
<body>
19+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20+
<div id="titlearea">
21+
<table cellspacing="0" cellpadding="0">
22+
<tbody>
23+
<tr style="height: 56px;">
24+
<td style="padding-left: 0.5em;">
25+
<div id="projectname">ChaiScript
26+
&#160;<span id="projectnumber">4.3.0</span>
27+
</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.8.4 -->
35+
<script type="text/javascript">
36+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
37+
</script>
38+
<div id="navrow1" class="tabs">
39+
<ul class="tablist">
40+
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
41+
<li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
42+
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
43+
<li><a href="annotated.html"><span>Classes</span></a></li>
44+
<li><a href="files.html"><span>Files</span></a></li>
45+
<li>
46+
<div id="MSearchBox" class="MSearchBoxInactive">
47+
<span class="left">
48+
<img id="MSearchSelect" src="search/mag_sel.png"
49+
onmouseover="return searchBox.OnSearchSelectShow()"
50+
onmouseout="return searchBox.OnSearchSelectHide()"
51+
alt=""/>
52+
<input type="text" id="MSearchField" value="Search" accesskey="S"
53+
onfocus="searchBox.OnSearchFieldFocus(true)"
54+
onblur="searchBox.OnSearchFieldFocus(false)"
55+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
56+
</span><span class="right">
57+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
58+
</span>
59+
</div>
60+
</li>
61+
</ul>
62+
</div>
63+
<!-- window showing the filter options -->
64+
<div id="MSearchSelectWindow"
65+
onmouseover="return searchBox.OnSearchSelectShow()"
66+
onmouseout="return searchBox.OnSearchSelectHide()"
67+
onkeydown="return searchBox.OnSearchSelectKey(event)">
68+
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
69+
70+
<!-- iframe showing the search results (closed by default) -->
71+
<div id="MSearchResultsWindow">
72+
<iframe src="javascript:void(0)" frameborder="0"
73+
name="MSearchResults" id="MSearchResults">
74+
</iframe>
75+
</div>
76+
77+
</div><!-- top -->
78+
<div class="header">
79+
<div class="headertitle">
80+
<div class="title">ChaiScript Language Getting Started </div> </div>
81+
</div><!--header-->
82+
<div class="contents">
83+
<div class="textblock"><p>ChaiScript is a simple language that should feel familiar to anyone who knows C++ or ECMAScript (JavaScript).</p>
84+
<hr/>
85+
<h1><a class="anchor" id="chaiscriptloops"></a>
86+
Loops</h1>
87+
<p>Common looping constructs exist in ChaiScript</p>
88+
<div class="fragment"><div class="line"><a class="code" href="namespacechaiscript.html#a9f286014050c479fd33bf935f781eca9" title="Creates a Boxed_Value. If the object passed in is a value type, it is copied. If it is a pointer...">var</a> i = 0;</div>
89+
<div class="line"><span class="keywordflow">while</span> (i &lt; 10)</div>
90+
<div class="line">{</div>
91+
<div class="line"> <span class="comment">// do something</span></div>
92+
<div class="line"> ++i;</div>
93+
<div class="line">}</div>
94+
</div><!-- fragment --><div class="fragment"><div class="line"><span class="keywordflow">for</span> (<a class="code" href="namespacechaiscript.html#a9f286014050c479fd33bf935f781eca9" title="Creates a Boxed_Value. If the object passed in is a value type, it is copied. If it is a pointer...">var</a> i = 0; i &lt; 10; ++i)</div>
95+
<div class="line">{</div>
96+
<div class="line"> <span class="comment">// do something</span></div>
97+
<div class="line">}</div>
98+
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="_lang_keyword_ref.html#keywordfor">for</a> </dd>
99+
<dd>
100+
<a class="el" href="_lang_keyword_ref.html#keywordwhile">while</a></dd></dl>
101+
<hr/>
102+
<h1><a class="anchor" id="chaiscriptifs"></a>
103+
Conditionals</h1>
104+
<p>If statements work as expected</p>
105+
<div class="fragment"><div class="line"><a class="code" href="namespacechaiscript.html#a9f286014050c479fd33bf935f781eca9" title="Creates a Boxed_Value. If the object passed in is a value type, it is copied. If it is a pointer...">var</a> b = <span class="keyword">true</span>;</div>
106+
<div class="line"></div>
107+
<div class="line"><span class="keywordflow">if</span> (b) {</div>
108+
<div class="line"> <span class="comment">// do something</span></div>
109+
<div class="line">} <span class="keywordflow">else</span> <span class="keywordflow">if</span> (c &lt; 10) {</div>
110+
<div class="line"> <span class="comment">// do something else</span></div>
111+
<div class="line">} <span class="keywordflow">else</span> {</div>
112+
<div class="line"> <span class="comment">// or do this</span></div>
113+
<div class="line">}</div>
114+
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="_lang_keyword_ref.html#keywordif">if</a></dd></dl>
115+
<hr/>
116+
<h1><a class="anchor" id="chaiscriptfunctions"></a>
117+
Functions</h1>
118+
<p>Functions are defined with the def keyword</p>
119+
<div class="fragment"><div class="line">def myfun(x) { <a class="code" href="namespace_chai_script___language.html#a997db82b5a5b891b648ea6a8b9cf3271" title="Prints o to the terminal, with a trailing carriage return. Applies conversions to string automaticall...">print</a>(x); }</div>
120+
<div class="line"></div>
121+
<div class="line">myfun(10);</div>
122+
</div><!-- fragment --><p>Functions may have "guards" which determine if which is called.</p>
123+
<div class="fragment"><div class="line">eval&gt; def myfun2(x) : x &lt; 10 { <a class="code" href="namespace_chai_script___language.html#a997db82b5a5b891b648ea6a8b9cf3271" title="Prints o to the terminal, with a trailing carriage return. Applies conversions to string automaticall...">print</a>(<span class="stringliteral">&quot;less than 10&quot;</span>); }</div>
124+
<div class="line">eval&gt; def myfun2(x) : x &gt;= 10 { <a class="code" href="namespace_chai_script___language.html#a997db82b5a5b891b648ea6a8b9cf3271" title="Prints o to the terminal, with a trailing carriage return. Applies conversions to string automaticall...">print</a>(<span class="stringliteral">&quot;10 or greater&quot;</span>); }</div>
125+
<div class="line">eval&gt; myfun2(5)</div>
126+
<div class="line">less than 10</div>
127+
<div class="line">eval&gt; myfun2(12)</div>
128+
<div class="line">10 or greater</div>
129+
</div><!-- fragment --><dl class="section see"><dt>See Also</dt><dd><a class="el" href="_lang_keyword_ref.html#keyworddef">def</a> </dd>
130+
<dd>
131+
<a class="el" href="_lang_keyword_ref.html#keywordattr">attr</a> </dd>
132+
<dd>
133+
<a class="el" href="_lang_object_system_ref.html">ChaiScript Language Object Model Reference</a></dd></dl>
134+
<hr/>
135+
<h1><a class="anchor" id="chaiscriptfunctionobjects"></a>
136+
Function Objects</h1>
137+
<p>Functions are first class types in ChaiScript and can be used as variables.</p>
138+
<div class="fragment"><div class="line">eval&gt; <a class="code" href="namespacechaiscript.html#a9f286014050c479fd33bf935f781eca9" title="Creates a Boxed_Value. If the object passed in is a value type, it is copied. If it is a pointer...">var</a> p = <a class="code" href="namespace_chai_script___language.html#a997db82b5a5b891b648ea6a8b9cf3271" title="Prints o to the terminal, with a trailing carriage return. Applies conversions to string automaticall...">print</a>;</div>
139+
<div class="line">eval&gt; p(1);</div>
140+
<div class="line">1</div>
141+
</div><!-- fragment --><p>They can also be passed to functions.</p>
142+
<div class="fragment"><div class="line">eval&gt; def callfunc(f, lhs, rhs) { <span class="keywordflow">return</span> f(lhs, rhs); }</div>
143+
<div class="line">eval&gt; def dosomething(lhs, rhs) { <a class="code" href="namespace_chai_script___language.html#a997db82b5a5b891b648ea6a8b9cf3271" title="Prints o to the terminal, with a trailing carriage return. Applies conversions to string automaticall...">print</a>(<span class="stringliteral">&quot;lhs: ${lhs}, rhs: ${rhs}&quot;</span>); }</div>
144+
<div class="line">eval&gt; callfunc(dosomething, 1, 2);</div>
145+
<div class="line">lhs: 1, rhs: 2</div>
146+
</div><!-- fragment --><p>Operators can also be treated as functions by using the back tick operator. Building on the above example:</p>
147+
<div class="fragment"><div class="line">eval&gt; callfunc(`+`, 1, 4);</div>
148+
<div class="line">5</div>
149+
<div class="line">eval&gt; callfunc(`*`, 3, 2);</div>
150+
<div class="line">6</div>
151+
</div><!-- fragment --><hr/>
152+
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="_lang_keyword_ref.html">ChaiScript Language Keyword Reference</a> </dd>
153+
<dd>
154+
<a class="el" href="namespace_chai_script___language.html" title="Items in this namespace exist in the ChaiScript language runtime. They are not part of the C++ API...">ChaiScript_Language</a> for Built in Functions </dd></dl>
155+
</div></div><!-- contents -->
156+
<!-- start footer part -->
157+
<hr class="footer"/><address class="footer"><small>
158+
Generated on Wed Mar 26 2014 14:52:40 for ChaiScript by &#160;<a href="http://www.doxygen.org/index.html">
159+
<img class="footer" src="doxygen.png" alt="doxygen"/>
160+
</a> 1.8.4
161+
</small></address>
162+
</body>
163+
</html>

‎docs/4/_lang_in_place_ref.html‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.4"/>
7+
<title>ChaiScript: ChaiScript Language In-Place Creation Reference</title>
8+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
9+
<script type="text/javascript" src="jquery.js"></script>
10+
<script type="text/javascript" src="dynsections.js"></script>
11+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
12+
<script type="text/javascript" src="search/search.js"></script>
13+
<script type="text/javascript">
14+
$(document).ready(function() { searchBox.OnSelectItem(0); });
15+
</script>
16+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
17+
</head>
18+
<body>
19+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
20+
<div id="titlearea">
21+
<table cellspacing="0" cellpadding="0">
22+
<tbody>
23+
<tr style="height: 56px;">
24+
<td style="padding-left: 0.5em;">
25+
<div id="projectname">ChaiScript
26+
&#160;<span id="projectnumber">4.3.0</span>
27+
</div>
28+
</td>
29+
</tr>
30+
</tbody>
31+
</table>
32+
</div>
33+
<!-- end header part -->
34+
<!-- Generated by Doxygen 1.8.4 -->
35+
<script type="text/javascript">
36+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
37+
</script>
38+
<div id="navrow1" class="tabs">
39+
<ul class="tablist">
40+
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
41+
<li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
42+
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
43+
<li><a href="annotated.html"><span>Classes</span></a></li>
44+
<li><a href="files.html"><span>Files</span></a></li>
45+
<li>
46+
<div id="MSearchBox" class="MSearchBoxInactive">
47+
<span class="left">
48+
<img id="MSearchSelect" src="search/mag_sel.png"
49+
onmouseover="return searchBox.OnSearchSelectShow()"
50+
onmouseout="return searchBox.OnSearchSelectHide()"
51+
alt=""/>
52+
<input type="text" id="MSearchField" value="Search" accesskey="S"
53+
onfocus="searchBox.OnSearchFieldFocus(true)"
54+
onblur="searchBox.OnSearchFieldFocus(false)"
55+
onkeyup="searchBox.OnSearchFieldChange(event)"/>
56+
</span><span class="right">
57+
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
58+
</span>
59+
</div>
60+
</li>
61+
</ul>
62+
</div>
63+
<!-- window showing the filter options -->
64+
<div id="MSearchSelectWindow"
65+
onmouseover="return searchBox.OnSearchSelectShow()"
66+
onmouseout="return searchBox.OnSearchSelectHide()"
67+
onkeydown="return searchBox.OnSearchSelectKey(event)">
68+
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>
69+
70+
<!-- iframe showing the search results (closed by default) -->
71+
<div id="MSearchResultsWindow">
72+
<iframe src="javascript:void(0)" frameborder="0"
73+
name="MSearchResults" id="MSearchResults">
74+
</iframe>
75+
</div>
76+
77+
</div><!-- top -->
78+
<div class="header">
79+
<div class="headertitle">
80+
<div class="title">ChaiScript Language In-Place Creation Reference </div> </div>
81+
</div><!--header-->
82+
<div class="contents">
83+
<div class="textblock"><h1><a class="anchor" id="inplacevector"></a>
84+
Vector</h1>
85+
<div class="fragment"><div class="line">In-place Vector ::= <span class="stringliteral">&quot;[&quot;</span> [expression (<span class="stringliteral">&quot;,&quot;</span> expression)*] <span class="stringliteral">&quot;]&quot;</span></div>
86+
</div><!-- fragment --><h1><a class="anchor" id="inplacerangedvector"></a>
87+
Ranged Vector</h1>
88+
<div class="fragment"><div class="line">In-place Ranged Vector ::= <span class="stringliteral">&quot;[&quot;</span> value <span class="stringliteral">&quot;..&quot;</span> value <span class="stringliteral">&quot;]&quot;</span></div>
89+
</div><!-- fragment --><p>Creates a vector over a range (eg. 1..10)</p>
90+
<h1><a class="anchor" id="inplacemap"></a>
91+
Map</h1>
92+
<div class="fragment"><div class="line">In-place Map ::= <span class="stringliteral">&quot;[&quot;</span> (<span class="keywordtype">string</span> <span class="stringliteral">&quot;:&quot;</span> expression)+ <span class="stringliteral">&quot;]&quot;</span></div>
93+
</div><!-- fragment --> </div></div><!-- contents -->
94+
<!-- start footer part -->
95+
<hr class="footer"/><address class="footer"><small>
96+
Generated on Wed Mar 26 2014 14:52:40 for ChaiScript by &#160;<a href="http://www.doxygen.org/index.html">
97+
<img class="footer" src="doxygen.png" alt="doxygen"/>
98+
</a> 1.8.4
99+
</small></address>
100+
</body>
101+
</html>

0 commit comments

Comments
 (0)