Skip to content

Commit 098a59f

Browse files
scriptorumscriptorum
committed
Added flaxen API
0 parents  commit 098a59f

File tree

667 files changed

+4862
-0
lines changed

Some content is hidden

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

667 files changed

+4862
-0
lines changed

‎flaxen/dox/Array.html‎

Lines changed: 103 additions & 0 deletions
Large diffs are not rendered by default.

‎flaxen/dox/ArrayAccess.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="utf-8"/><link href="./bootstrap-combined.min.css" rel="stylesheet" /><script type="text/javascript" src="./jquery-1.9.1.min.js"></script><script type="text/javascript" src="./bootstrap.min.js"></script><link href="./styles.css" rel="stylesheet" /><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><script type="text/javascript">var dox = {rootPath: "./",platforms: ["dox"]};</script><title>ArrayAccess - Flaxen API</title></head><body><div class="navbar navbar-inverse navbar-fixed-top"><div class="navbar-inner"><form class="navbar-search pull-left" id="searchForm"><input id="search" type="text" class="search-query" placeholder="Filter" autocomplete="off"/></form><ul class="nav"><li id="select-platform" class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Platform<b class="caret"></b></a><ul class="dropdown-menu"><li data="all"><a href="#">All Platforms</a></li><li data="dox"><a href="#">dox</a></li></ul></li></ul></div></div><div id="container"><div id="nav"></div><div id="content"><div class="header"><span class="viewsource"><a href="https://github.com/scriptorum/flaxen/tree/master/StdTypes.hx">View source</a></span><h1><code><span class="directive">interface </span><span class="type">ArrayAccess</span>&lt;<span class="type">T</span>&gt;</code></h1></div><div class="body"><p class="availability">Available on all platforms</p><div class="doc"><p>ArrayAccess is used to indicate a class that can be accessed using brackets.
3+
The type parameter represent the type of the elements stored.</p></div></div></div></div></body></html>

‎flaxen/dox/Bool.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="utf-8"/><link href="./bootstrap-combined.min.css" rel="stylesheet" /><script type="text/javascript" src="./jquery-1.9.1.min.js"></script><script type="text/javascript" src="./bootstrap.min.js"></script><link href="./styles.css" rel="stylesheet" /><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><script type="text/javascript">var dox = {rootPath: "./",platforms: ["dox"]};</script><title>Bool - Flaxen API</title></head><body><div class="navbar navbar-inverse navbar-fixed-top"><div class="navbar-inner"><form class="navbar-search pull-left" id="searchForm"><input id="search" type="text" class="search-query" placeholder="Filter" autocomplete="off"/></form><ul class="nav"><li id="select-platform" class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Platform<b class="caret"></b></a><ul class="dropdown-menu"><li data="all"><a href="#">All Platforms</a></li><li data="dox"><a href="#">dox</a></li></ul></li></ul></div></div><div id="container"><div id="nav"></div><div id="content"><div class="header"><span class="viewsource"><a href="https://github.com/scriptorum/flaxen/tree/master/StdTypes.hx">View source</a></span><h1><code><span class="directive">abstract </span><span class="type">Bool</span>(<a class="type" href="./Bool.html">Bool</a>)</code></h1></div><div class="body"><p class="availability">Available on all platforms</p><div class="doc"><p>The standard Boolean type, which can either be true or false.</p>
3+
<p>On static targets, null cannot be assigned to Bool. If this is necessary,
4+
<code><a href="./Null.html">Null</a>&lt;<a href="./Bool.html">Bool</a>&gt;</code> can be used instead.</p></div></div></div></div></body></html>

‎flaxen/dox/Class.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="utf-8"/><link href="./bootstrap-combined.min.css" rel="stylesheet" /><script type="text/javascript" src="./jquery-1.9.1.min.js"></script><script type="text/javascript" src="./bootstrap.min.js"></script><link href="./styles.css" rel="stylesheet" /><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><script type="text/javascript">var dox = {rootPath: "./",platforms: ["dox"]};</script><title>Class - Flaxen API</title></head><body><div class="navbar navbar-inverse navbar-fixed-top"><div class="navbar-inner"><form class="navbar-search pull-left" id="searchForm"><input id="search" type="text" class="search-query" placeholder="Filter" autocomplete="off"/></form><ul class="nav"><li id="select-platform" class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Platform<b class="caret"></b></a><ul class="dropdown-menu"><li data="all"><a href="#">All Platforms</a></li><li data="dox"><a href="#">dox</a></li></ul></li></ul></div></div><div id="container"><div id="nav"></div><div id="content"><div class="header"><span class="viewsource"><a href="https://github.com/scriptorum/flaxen/tree/master/Class.hx">View source</a></span><h1><code><span class="directive">abstract </span><span class="type">Class</span>&lt;<span class="type">T</span>&gt;(<a class="type" href="./Class.html">Class</a>&lt;<span class="type">T</span>&gt;)</code></h1></div><div class="body"><p class="availability">Available on all platforms</p><div class="doc"><p>An abstract type that represents a Class.</p>
3+
<p>See <code><a href="./Type.html">Type</a></code> for the Haxe Reflection API.</p></div></div></div></div></body></html>

‎flaxen/dox/Date.html‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="utf-8"/><link href="./bootstrap-combined.min.css" rel="stylesheet" /><script type="text/javascript" src="./jquery-1.9.1.min.js"></script><script type="text/javascript" src="./bootstrap.min.js"></script><link href="./styles.css" rel="stylesheet" /><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><script type="text/javascript">var dox = {rootPath: "./",platforms: ["dox"]};</script><title>Date - Flaxen API</title></head><body><div class="navbar navbar-inverse navbar-fixed-top"><div class="navbar-inner"><form class="navbar-search pull-left" id="searchForm"><input id="search" type="text" class="search-query" placeholder="Filter" autocomplete="off"/></form><ul class="nav"><li id="select-platform" class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Platform<b class="caret"></b></a><ul class="dropdown-menu"><li data="all"><a href="#">All Platforms</a></li><li data="dox"><a href="#">dox</a></li></ul></li></ul></div></div><div id="container"><div id="nav"></div><div id="content"><div class="header"><span class="viewsource"><a href="https://github.com/scriptorum/flaxen/tree/master/Date.hx">View source</a></span><h1><code><span class="directive">class </span><span class="type">Date</span></code></h1></div><div class="body"><p class="availability">Available on all platforms</p><div class="doc"><p>The Date class provides a basic structure for date and time related
3+
information. Date instances can be created by</p><ul><li><code>new <a href="./Date.html">Date</a>()</code> for a specific date,</li><li><code><a href="./Date.html#now">Date.now</a>()</code> to obtain information about the current time,</li><li><code><a href="./Date.html#fromTime">Date.fromTime</a>()</code> with a given timestamp or</li><li><code><a href="./Date.html#fromString">Date.fromString</a>()</code> by parsing from a String.</li></ul>
4+
<p>There is some extra functions available in the <code>DateTools</code> class.</p>
5+
<p>In the context of haxe dates, a timestamp is defined as the number of
6+
milliseconds elapsed since 1st January 1970.</p></div><h2>Class Fields</h2><div class="platform platform-dox"><a name="fromString"></a><h3><p><code><span class="keyword">static </span><span class="keyword">function</span> <a href="#fromString"><span class="identifier">fromString</span></a>(s:<a class="type" href="./String.html">String</a>):<a class="type" href="./Date.html">Date</a></code></p></h3><div class="doc"><p>Returns a Date from a formated string <code>s</code>, with the following accepted
7+
formats:</p><ul><li><code>"YYYY-MM-DD hh:mm:ss"</code></li><li><code>"YYYY-MM-DD"</code></li><li><code>"hh:mm:ss"</code></li></ul>
8+
<p>The first two formats are expressed in local time, the third in UTC
9+
Epoch.</p></div></div><div class="platform platform-dox"><a name="fromTime"></a><h3><p><code><span class="keyword">static </span><span class="keyword">function</span> <a href="#fromTime"><span class="identifier">fromTime</span></a>(t:<a class="type" href="./Float.html">Float</a>):<a class="type" href="./Date.html">Date</a></code></p></h3><div class="doc"><p>Returns a Date from timestamp <code>t</code>.</p></div></div><div class="platform platform-dox"><a name="now"></a><h3><p><code><span class="keyword">static </span><span class="keyword">function</span> <a href="#now"><span class="identifier">now</span></a>():<a class="type" href="./Date.html">Date</a></code></p></h3><div class="doc"><p>Returns a Date representing the current local time.</p></div></div><h2>Instance Fields</h2><div class="platform platform-dox"><a name="new"></a><h3><p><code><span class="keyword">function</span> <a href="#new"><span class="identifier">new</span></a>(year:<a class="type" href="./Int.html">Int</a>, month:<a class="type" href="./Int.html">Int</a>, day:<a class="type" href="./Int.html">Int</a>, hour:<a class="type" href="./Int.html">Int</a>, min:<a class="type" href="./Int.html">Int</a>, sec:<a class="type" href="./Int.html">Int</a>):<a class="type" href="./Void.html">Void</a></code></p></h3><div class="doc"><p>Creates a new date object from the given arguments.</p>
10+
<p>The behaviour of a Date instance is only consistent across platforms if
11+
the the arguments describe a valid date.</p><ul><li>month: 0 to 11</li><li>day: 1 to 31</li><li>hour: 0 to 23</li><li>min: 0 to 59</li><li>sec: 0 to 59</li></ul></div></div><div class="platform platform-dox"><a name="getDate"></a><h3><p><code><span class="keyword">function</span> <a href="#getDate"><span class="identifier">getDate</span></a>():<a class="type" href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Returns the day of <code>this</code> Date (1-31 range).</p></div></div><div class="platform platform-dox"><a name="getDay"></a><h3><p><code><span class="keyword">function</span> <a href="#getDay"><span class="identifier">getDay</span></a>():<a class="type" href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Returns the day of the week of <code>this</code> Date (0-6 range).</p></div></div><div class="platform platform-dox"><a name="getFullYear"></a><h3><p><code><span class="keyword">function</span> <a href="#getFullYear"><span class="identifier">getFullYear</span></a>():<a class="type" href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Returns the full year of <code>this</code> Date (4-digits).</p></div></div><div class="platform platform-dox"><a name="getHours"></a><h3><p><code><span class="keyword">function</span> <a href="#getHours"><span class="identifier">getHours</span></a>():<a class="type" href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Returns the hours of <code>this</code> Date (0-23 range).</p></div></div><div class="platform platform-dox"><a name="getMinutes"></a><h3><p><code><span class="keyword">function</span> <a href="#getMinutes"><span class="identifier">getMinutes</span></a>():<a class="type" href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Returns the minutes of <code>this</code> Date (0-59 range).</p></div></div><div class="platform platform-dox"><a name="getMonth"></a><h3><p><code><span class="keyword">function</span> <a href="#getMonth"><span class="identifier">getMonth</span></a>():<a class="type" href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Returns the month of <code>this</code> Date (0-11 range).</p></div></div><div class="platform platform-dox"><a name="getSeconds"></a><h3><p><code><span class="keyword">function</span> <a href="#getSeconds"><span class="identifier">getSeconds</span></a>():<a class="type" href="./Int.html">Int</a></code></p></h3><div class="doc"><p>Returns the seconds of the <code>this</code> Date (0-59 range).</p></div></div><div class="platform platform-dox"><a name="getTime"></a><h3><p><code><span class="keyword">function</span> <a href="#getTime"><span class="identifier">getTime</span></a>():<a class="type" href="./Float.html">Float</a></code></p></h3><div class="doc"><p>Returns the timestamp of the date. It might only have a per-second
12+
precision depending on the platforms.</p></div></div><div class="platform platform-dox"><a name="toString"></a><h3><p><code><span class="keyword">function</span> <a href="#toString"><span class="identifier">toString</span></a>():<a class="type" href="./String.html">String</a></code></p></h3><div class="doc"><p>Returns a string representation of <code>this</code> Date, by using the
13+
standard format [YYYY-MM-DD HH:MM:SS]. See <code>DateTools.format</code> for
14+
other formating rules.</p></div></div></div></div></div></body></html>

‎flaxen/dox/Dynamic.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="utf-8"/><link href="./bootstrap-combined.min.css" rel="stylesheet" /><script type="text/javascript" src="./jquery-1.9.1.min.js"></script><script type="text/javascript" src="./bootstrap.min.js"></script><link href="./styles.css" rel="stylesheet" /><link rel="icon" href="./favicon.ico" type="image/x-icon"></link><script type="text/javascript" src="./nav.js"></script><script type="text/javascript" src="./index.js"></script><script type="text/javascript">var dox = {rootPath: "./",platforms: ["dox"]};</script><title>Dynamic - Flaxen API</title></head><body><div class="navbar navbar-inverse navbar-fixed-top"><div class="navbar-inner"><form class="navbar-search pull-left" id="searchForm"><input id="search" type="text" class="search-query" placeholder="Filter" autocomplete="off"/></form><ul class="nav"><li id="select-platform" class="dropdown"><a href="#" class="dropdown-toggle" data-toggle="dropdown">Platform<b class="caret"></b></a><ul class="dropdown-menu"><li data="all"><a href="#">All Platforms</a></li><li data="dox"><a href="#">dox</a></li></ul></li></ul></div></div><div id="container"><div id="nav"></div><div id="content"><div class="header"><span class="viewsource"><a href="https://github.com/scriptorum/flaxen/tree/master/StdTypes.hx">View source</a></span><h1><code><span class="directive">abstract </span><span class="type">Dynamic</span>&lt;<span class="type">T</span>&gt;(<a class="type" href="./Dynamic.html">Dynamic</a>&lt;<span class="type">T</span>&gt;)</code></h1></div><div class="body"><p class="availability">Available on all platforms</p><div class="doc"><p>Dynamic is a special type which is compatible with all other types.</p>
3+
<p>Use of Dynamic should be minimized as it prevents several compiler
4+
checks and optimizations.</p></div></div></div></div></body></html>

0 commit comments

Comments
 (0)