Skip to content

Commit 7852ac0

Browse files
committed
import xml doc of development (033a9fd42a223ba7b8bd3c4b373a145c118393f1)
1 parent 27f16d8 commit 7852ac0

File tree

11 files changed

+2045
-886
lines changed

11 files changed

+2045
-886
lines changed

xml/development/cpp.xml

Lines changed: 134 additions & 112 deletions
Large diffs are not rendered by default.

xml/development/flash.xml

Lines changed: 234 additions & 33 deletions
Large diffs are not rendered by default.

xml/development/hl.xml

Lines changed: 120 additions & 92 deletions
Large diffs are not rendered by default.

xml/development/info.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit": "69dbe0e7f0d8879afb223ace85543e06ea253d19",
2+
"commit": "033a9fd42a223ba7b8bd3c4b373a145c118393f1",
33
"branch": "development"
44
}

xml/development/js.xml

Lines changed: 43 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -5900,7 +5900,7 @@
59005900
<x path="Float"/>
59015901
<meta><m n=":value"><e>Math.NEGATIVE_INFINITY</e></m></meta>
59025902
</nextRun>
5903-
<delay public="1" set="method" line="39">
5903+
<delay public="1" set="method" line="40">
59045904
<f a="t:?fromLastRun" v=":false">
59055905
<x path="Null"><x path="Float"/></x>
59065906
<x path="Bool"/>
@@ -5910,22 +5910,22 @@
59105910
<haxe_doc>Delay the execution of the event for the given time, in seconds.
59115911
If t is null, the event will be run at next event loop.</haxe_doc>
59125912
</delay>
5913-
<stop public="1" set="method" line="46">
5913+
<stop public="1" set="method" line="47">
59145914
<f a=""><x path="Void"/></f>
59155915
<haxe_doc>Stop this event from repeating.</haxe_doc>
59165916
</stop>
5917-
<start public="1" set="method" line="53">
5917+
<start public="1" set="method" line="54">
59185918
<f a="callb">
59195919
<f a=""><x path="Void"/></f>
59205920
<x path="Void"/>
59215921
</f>
59225922
<haxe_doc>Start the event with the given callback function.</haxe_doc>
59235923
</start>
5924-
<isStopped public="1" set="method" line="61">
5924+
<isStopped public="1" set="method" line="62">
59255925
<f a=""><x path="Bool"/></f>
59265926
<haxe_doc>Tells if the event has been stopped.</haxe_doc>
59275927
</isStopped>
5928-
<new set="method" line="30"><f a="loop:p">
5928+
<new set="method" line="31"><f a="loop:p">
59295929
<c path="haxe.EventLoop"/>
59305930
<x path="Int"/>
59315931
<x path="Void"/>
@@ -5947,22 +5947,21 @@
59475947
<haxe_doc>This is the current thread event loop. For platforms that doesn't support threads
59485948
it is the same as `main`.</haxe_doc>
59495949
</current>
5950-
<hasRunningThreads public="1" set="method" line="432" static="1">
5950+
<hasRunningThreads public="1" set="method" line="446" static="1">
59515951
<f a=""><x path="Bool"/></f>
59525952
<haxe_doc>Tells if we currently have blocking unfinished threads.</haxe_doc>
59535953
</hasRunningThreads>
5954-
<addTask public="1" set="method" line="466" static="1">
5954+
<addTask public="1" set="method" line="483" static="1">
59555955
<f a="f:?blocking" v=":true">
59565956
<f a=""><x path="Void"/></f>
59575957
<x path="Bool"/>
59585958
<x path="Void"/>
59595959
</f>
59605960
<meta><m n=":value"><e>{ blocking : true }</e></m></meta>
5961-
<haxe_doc>Add a task to be run either on another thread or as part of the main event loop if the
5962-
platform does not support threads.</haxe_doc>
5961+
<haxe_doc>Adds `f` as a thread task on the main thread.</haxe_doc>
59635962
</addTask>
5964-
<get_current set="method" line="489" static="1"><f a=""><c path="haxe.EventLoop"/></f></get_current>
5965-
<get_main set="method" line="499" static="1"><f a=""><c path="haxe.EventLoop"/></f></get_main>
5963+
<get_current set="method" line="522" static="1"><f a=""><c path="haxe.EventLoop"/></f></get_current>
5964+
<get_main set="method" line="532" static="1"><f a=""><c path="haxe.EventLoop"/></f></get_main>
59665965
<events><c path="haxe.Event"/></events>
59675966
<queue><c path="haxe.Event"/></queue>
59685967
<inLoop><x path="Bool"/></inLoop>
@@ -5976,33 +5975,33 @@
59765975
<x path="Bool"/>
59775976
<meta><m n=":value"><e>false</e></m></meta>
59785977
</inNative>
5979-
<dispose public="1" set="method" line="125">
5978+
<dispose public="1" set="method" line="128">
59805979
<f a=""><x path="Void"/></f>
59815980
<haxe_doc>This should be called after you are finished with a custom event loop.
59825981
It is already automatically called for threads loops.</haxe_doc>
59835982
</dispose>
5984-
<loop public="1" set="method" line="133">
5983+
<loop public="1" set="method" line="136">
59855984
<f a=""><x path="Void"/></f>
59865985
<haxe_doc>Runs until all the blocking events have been stopped.
59875986
If this is called on the main thread, also wait for all blocking threads to finish.</haxe_doc>
59885987
</loop>
5989-
<promise public="1" set="method" line="151">
5988+
<promise public="1" set="method" line="165">
59905989
<f a=""><x path="Void"/></f>
59915990
<haxe_doc>Promise a possible future event addition. This will prevent the `loop()` from terminating until the matching number of `deliver()` calls have been made.</haxe_doc>
59925991
</promise>
5993-
<deliver public="1" set="method" line="160">
5992+
<deliver public="1" set="method" line="174">
59945993
<f a=""><x path="Void"/></f>
59955994
<haxe_doc>Deliver after a `promise()`. This will throw an exception if more `deliver()` calls has been made than corresponding `promise()` calls.</haxe_doc>
59965995
</deliver>
5997-
<wakeup get="inline" set="null" line="172"><f a=""><x path="Void"/></f></wakeup>
5998-
<wait get="inline" set="null" line="178"><f a="time">
5996+
<wakeup get="inline" set="null" line="186"><f a=""><x path="Void"/></f></wakeup>
5997+
<wait get="inline" set="null" line="192"><f a="time">
59995998
<x path="Float"/>
60005999
<x path="Void"/>
60016000
</f></wait>
6002-
<lock get="inline" set="null" line="186"><f a=""><x path="Void"/></f></lock>
6003-
<unlock get="inline" set="null" line="192"><f a=""><x path="Void"/></f></unlock>
6004-
<checkThread set="method" line="198"><f a=""><x path="Void"/></f></checkThread>
6005-
<loopOnce public="1" set="method" line="209">
6001+
<lock get="inline" set="null" line="200"><f a=""><x path="Void"/></f></lock>
6002+
<unlock get="inline" set="null" line="206"><f a=""><x path="Void"/></f></unlock>
6003+
<checkThread set="method" line="212"><f a=""><x path="Void"/></f></checkThread>
6004+
<loopOnce public="1" set="method" line="223">
60066005
<f a="?threadCheck" v="true">
60076006
<x path="Bool"/>
60086007
<x path="Void"/>
@@ -6012,7 +6011,7 @@
60126011
By default, an event loop from a thread can only be triggered from this thread.
60136012
You can set `threadCheck` to false in the rare cases you might want otherwise.</haxe_doc>
60146013
</loopOnce>
6015-
<add public="1" set="method" line="252">
6014+
<add public="1" set="method" line="266">
60166015
<f a="callb:?priority" v=":0">
60176016
<f a=""><x path="Void"/></f>
60186017
<x path="Int"/>
@@ -6021,7 +6020,7 @@
60216020
<meta><m n=":value"><e>{ priority : 0 }</e></m></meta>
60226021
<haxe_doc>Add a callback to be run at each loop of the event loop.</haxe_doc>
60236022
</add>
6024-
<addAsync public="1" set="method" line="263">
6023+
<addAsync public="1" set="method" line="277">
60256024
<f a="?priority" v="0">
60266025
<x path="Int"/>
60276026
<c path="haxe.Event"/>
@@ -6031,7 +6030,7 @@
60316030
This is useful if you wish to hold a reference of another thread Event loop
60326031
before it runs.</haxe_doc>
60336032
</addAsync>
6034-
<addTimer public="1" set="method" line="270">
6033+
<addTimer public="1" set="method" line="284">
60356034
<f a="callb:delay:?priority" v="::0">
60366035
<f a=""><x path="Void"/></f>
60376036
<x path="Float"/>
@@ -6041,7 +6040,7 @@
60416040
<meta><m n=":value"><e>{ priority : 0 }</e></m></meta>
60426041
<haxe_doc>Add a callback to be run every `delay` seconds until stopped</haxe_doc>
60436042
</addTimer>
6044-
<repeat public="1" set="method" line="277">
6043+
<repeat public="1" set="method" line="291">
60456044
<f a="callb:delay">
60466045
<f a=""><x path="Void"/></f>
60476046
<x path="Int"/>
@@ -6052,7 +6051,7 @@
60526051
<m n=":noCompletion"/>
60536052
</meta>
60546053
</repeat>
6055-
<cancel public="1" set="method" line="281">
6054+
<cancel public="1" set="method" line="295">
60566055
<f a="e">
60576056
<c path="haxe.Event"/>
60586057
<x path="Void"/>
@@ -6062,7 +6061,7 @@
60626061
<m n=":noCompletion"/>
60636062
</meta>
60646063
</cancel>
6065-
<run public="1" set="method" line="288">
6064+
<run public="1" set="method" line="302">
60666065
<f a="callb:?priority" v=":0">
60676066
<f a=""><x path="Void"/></f>
60686067
<x path="Int"/>
@@ -6071,17 +6070,18 @@
60716070
<meta><m n=":value"><e>{ priority : 0 }</e></m></meta>
60726071
<haxe_doc>Add a function to be run once at next loop of the event loop.</haxe_doc>
60736072
</run>
6074-
<start set="method" line="294"><f a="e">
6073+
<start set="method" line="308"><f a="e">
60756074
<c path="haxe.Event"/>
60766075
<x path="Void"/>
60776076
</f></start>
6078-
<stop set="method" line="311"><f a="e">
6077+
<stop set="method" line="325"><f a="e">
60796078
<c path="haxe.Event"/>
60806079
<x path="Void"/>
60816080
</f></stop>
6082-
<getNextTick set="method" line="340"><f a=""><x path="Float"/></f></getNextTick>
6083-
<sortEvents set="method" line="362"><f a=""><x path="Void"/></f></sortEvents>
6084-
<hasEvents public="1" set="method" line="444">
6081+
<getNextTick set="method" line="354"><f a=""><x path="Float"/></f></getNextTick>
6082+
<sortEvents set="method" line="376"><f a=""><x path="Void"/></f></sortEvents>
6083+
<hasRunningThreadTasks set="method" line="450"><f a=""><x path="Bool"/></f></hasRunningThreadTasks>
6084+
<hasEvents public="1" set="method" line="462">
60856085
<f a="?blocking" v="true">
60866086
<x path="Bool"/>
60876087
<x path="Bool"/>
@@ -6090,7 +6090,17 @@
60906090
<haxe_doc>Tells if the event loop has remaining events.
60916091
If blocking is set to true, only check if it has remaining blocking events.</haxe_doc>
60926092
</hasEvents>
6093-
<new public="1" set="method" line="114"><f a=""><x path="Void"/></f></new>
6093+
<addThreadTask public="1" set="method" line="491">
6094+
<f a="f:?blocking" v=":true">
6095+
<f a=""><x path="Void"/></f>
6096+
<x path="Bool"/>
6097+
<x path="Void"/>
6098+
</f>
6099+
<meta><m n=":value"><e>{ blocking : true }</e></m></meta>
6100+
<haxe_doc>Add a task to be run either on another thread or as part of this event loop if the
6101+
platform does not support threads.</haxe_doc>
6102+
</addThreadTask>
6103+
<new public="1" set="method" line="116"><f a=""><x path="Void"/></f></new>
60946104
<haxe_doc>Handles async events for all threads</haxe_doc>
60956105
<meta><m n=":access"><e>haxe.Event</e></m></meta>
60966106
</class>

0 commit comments

Comments
 (0)