Skip to content

Commit

Permalink
import xml doc of development (e88f17048008dff9e503bb95ab62aa7003b16878)
Browse files Browse the repository at this point in the history
  • Loading branch information
haxe-ci committed Nov 11, 2024
1 parent af35696 commit c00665a
Show file tree
Hide file tree
Showing 11 changed files with 200 additions and 200 deletions.
42 changes: 21 additions & 21 deletions xml/development/cpp.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2285,7 +2285,7 @@

Leading whitespaces are ignored.

`x` may optionally start with a + or - to denote a postive or negative value respectively.
`x` may optionally start with a + or - to denote a positive or negative value respectively.

If the optional sign is followed 0x or 0X, hexadecimal notation is recognized where the following
digits may contain 0-9 and A-F. Both the prefix and digits are case insensitive.
Expand Down Expand Up @@ -2598,7 +2598,7 @@
is performed within `this` String. In either case, the returned position
is relative to the beginning of `this` String.

If `startIndex` is negative, the result is unspecifed.
If `startIndex` is negative, the result is unspecified.

If `str` cannot be found, -1 is returned.</haxe_doc>
</lastIndexOf>
Expand Down Expand Up @@ -3307,7 +3307,7 @@
<c path="String"/>
<x path="Bool"/>
</f>
<haxe_doc>Changes the current time locale, which will affect `DateTools.format` date formating.
<haxe_doc>Changes the current time locale, which will affect `DateTools.format` date formatting.
Returns `true` if the locale was successfully changed.</haxe_doc>
</setTimeLocale>
<getCwd public="1" set="method" line="78" static="1">
Expand Down Expand Up @@ -5467,7 +5467,7 @@
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Removes a child from the Document or Element.
Returns true if the child was successfuly removed.</haxe_doc>
Returns true if the child was successfully removed.</haxe_doc>
</removeChild>
<insertChild public="1" set="method" line="381">
<f a="x:pos">
Expand Down Expand Up @@ -9843,7 +9843,7 @@
<c path="cpp.net.ThreadServer.Message"/>
<x path="Void"/>
</f>
<haxe_doc>Called when a message has been recieved. Message handling code should go here.</haxe_doc>
<haxe_doc>Called when a message has been received. Message handling code should go here.</haxe_doc>
</clientMessage>
<update public="1" set="dynamic" line="357">
<f a=""><x path="Void"/></f>
Expand Down Expand Up @@ -10575,7 +10575,7 @@
<haxe_doc>Sets the handler callback to be made when asynchronous events occur,
specifically, when threads are created, terminated, started, or
stopped. The calling thread becomes the "debugger" thread, which means
that it will be discluded from any breakpoints and will not be reported
that it will be excluded from any breakpoints and will not be reported
on by any thread reporting requests.

Be aware that this callback is made asynchronously and possibly by
Expand Down Expand Up @@ -14746,7 +14746,7 @@
</a>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Performs signed integer divison of `dividend` by `divisor`.
<haxe_doc>Performs signed integer division of `dividend` by `divisor`.
Returns `{ quotient : Int64, modulus : Int64 }`.</haxe_doc>
</divMod>
<neg public="1" get="inline" set="null" line="209" static="1">
Expand Down Expand Up @@ -15403,7 +15403,7 @@
</a>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Performs signed integer divison of `dividend` by `divisor`.
<haxe_doc>Performs signed integer division of `dividend` by `divisor`.
Returns `{ quotient : Int64, modulus : Int64 }`.</haxe_doc>
</divMod>
<neg public="1" get="inline" set="null" line="209" static="1">
Expand Down Expand Up @@ -19883,7 +19883,7 @@
<m n=":enum"/>
</meta>
<haxe_doc>The field is declared on a parent type, such as:
- a super class field that is not overriden
- a super class field that is not overridden
- a forwarded abstract field</haxe_doc>
</Parent>
<StaticExtension public="1" get="inline" set="null" expr="cast 3" line="1" static="1">
Expand Down Expand Up @@ -19956,7 +19956,7 @@
<m n=":enum"/>
</meta>
<haxe_doc>The field is declared on a parent type, such as:
- a super class field that is not overriden
- a super class field that is not overridden
- a forwarded abstract field</haxe_doc>
</Parent>
<StaticExtension public="1" get="inline" set="null" expr="cast 3" line="1" static="1">
Expand Down Expand Up @@ -21981,7 +21981,7 @@
<m n=":impl"/>
<m n=":enum"/>
</meta>
<haxe_doc>Find references to the base field and all the overidding fields in the inheritance chain.</haxe_doc>
<haxe_doc>Find references to the base field and all the overriding fields in the inheritance chain.</haxe_doc>
</WithBaseAndDescendants>
<WithDescendants public="1" get="inline" set="null" expr="cast &quot;withDescendants&quot;" line="519" static="1">
<x path="haxe.display.FindReferencesKind"/>
Expand Down Expand Up @@ -22014,7 +22014,7 @@
<m n=":impl"/>
<m n=":enum"/>
</meta>
<haxe_doc>Find references to the base field and all the overidding fields in the inheritance chain.</haxe_doc>
<haxe_doc>Find references to the base field and all the overriding fields in the inheritance chain.</haxe_doc>
</WithBaseAndDescendants>
<WithDescendants public="1" get="inline" set="null" expr="cast &quot;withDescendants&quot;" line="519" static="1">
<x path="haxe.display.FindReferencesKind"/>
Expand Down Expand Up @@ -28997,7 +28997,7 @@
<exclude>
<x path="Null"><c path="Array"><c path="String"/></c></x>
<meta><m n=":optional"/></meta>
<haxe_doc>Dot paths of modules or packages to be exluded from the archive.</haxe_doc>
<haxe_doc>Dot paths of modules or packages to be excluded from the archive.</haxe_doc>
</exclude>
</a></typedef>
<typedef path="haxe.hxb.WriterConfig" params="" file="/home/runner/work/haxe/haxe/std/haxe/hxb/WriterConfig.hx"><a>
Expand Down Expand Up @@ -29775,7 +29775,7 @@
<meta><m n=":directlyUsed"/></meta>
</class>
<enum path="haxe.io.Error" params="" file="/home/runner/work/haxe/haxe/std/haxe/io/Error.hx">
<Blocked><haxe_doc>The IO is set into nonblocking mode and some data cannot be read or written</haxe_doc></Blocked>
<Blocked><haxe_doc>The IO is set into non-blocking mode and some data cannot be read or written</haxe_doc></Blocked>
<Overflow><haxe_doc>An integer value is outside its allowed range</haxe_doc></Overflow>
<OutsideBounds><haxe_doc>An operation on Bytes is outside of its valid range</haxe_doc></OutsideBounds>
<Custom a="e">
Expand Down Expand Up @@ -37129,7 +37129,7 @@
<meta>
<x path="Null"><t path="haxe.macro.Metadata"/></x>
<meta><m n=":optional"/></meta>
<haxe_doc>Metadata associatied with the variable, if available.</haxe_doc>
<haxe_doc>Metadata associated with the variable, if available.</haxe_doc>
</meta>
<isStatic>
<x path="Null"><x path="Bool"/></x>
Expand Down Expand Up @@ -37921,7 +37921,7 @@
<t path="haxe.macro.ClassType"/>
<x path="Void"/>
</f>
<haxe_doc>select the current classe</haxe_doc>
<haxe_doc>select the current class</haxe_doc>
</setCurrentClass>
<quoteString set="method">
<f a="s">
Expand Down Expand Up @@ -43389,7 +43389,7 @@
<x path="Void"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Configure additionals certificates and private keys for Server Name Indication extension.
<haxe_doc>Configure additional certificates and private keys for Server Name Indication extension.
The callback may be called during handshake to determine the certificate to use.</haxe_doc>
</addSNICertificate>
<bind public="1" set="method" line="234" override="1">
Expand Down Expand Up @@ -43596,7 +43596,7 @@
<shutdown public="1" set="method">
<f a=""><x path="Void"/></f>
<haxe_doc>Initiates a shutdown.
All previousely submitted tasks will be executed, but no new tasks will
All previously submitted tasks will be executed, but no new tasks will
be accepted.

Multiple calls to this method have no effect.</haxe_doc>
Expand Down Expand Up @@ -43641,7 +43641,7 @@
<shutdown public="1" set="method" line="111">
<f a=""><x path="Void"/></f>
<haxe_doc>Initiates a shutdown.
All previousely submitted tasks will be executed, but no new tasks will
All previously submitted tasks will be executed, but no new tasks will
be accepted.

Multiple calls to this method have no effect.</haxe_doc>
Expand Down Expand Up @@ -43772,7 +43772,7 @@
<shutdown public="1" set="method" line="80">
<f a=""><x path="Void"/></f>
<haxe_doc>Initiates a shutdown.
All previousely submitted tasks will be executed, but no new tasks will
All previously submitted tasks will be executed, but no new tasks will
be accepted.

Multiple calls to this method have no effect.</haxe_doc>
Expand Down Expand Up @@ -43917,7 +43917,7 @@
<haxe_doc>Try to lock the semaphore.
If the value of the semaphore is zero, `false` is returned, else the value is increased.

If `timeout` is specified, this function will block until the thread is able to acquire the semaphore, or the timout expires.
If `timeout` is specified, this function will block until the thread is able to acquire the semaphore, or the timeout expires.
`timeout` is in seconds.</haxe_doc>
</tryAcquire>
<release public="1" set="method" line="19">
Expand Down
28 changes: 14 additions & 14 deletions xml/development/flash.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1993,7 +1993,7 @@

Leading whitespaces are ignored.

`x` may optionally start with a + or - to denote a postive or negative value respectively.
`x` may optionally start with a + or - to denote a positive or negative value respectively.

If the optional sign is followed 0x or 0X, hexadecimal notation is recognized where the following
digits may contain 0-9 and A-F. Both the prefix and digits are case insensitive.
Expand Down Expand Up @@ -2278,7 +2278,7 @@
is performed within `this` String. In either case, the returned position
is relative to the beginning of `this` String.

If `startIndex` is negative, the result is unspecifed.
If `startIndex` is negative, the result is unspecified.

If `str` cannot be found, -1 is returned.</haxe_doc>
</lastIndexOf>
Expand Down Expand Up @@ -4704,7 +4704,7 @@
<x path="Bool"/>
</f>
<haxe_doc>Removes a child from the Document or Element.
Returns true if the child was successfuly removed.</haxe_doc>
Returns true if the child was successfully removed.</haxe_doc>
</removeChild>
<insertChild public="1" set="method" line="381">
<f a="x:pos">
Expand Down Expand Up @@ -4735,7 +4735,7 @@
<this><x path="flash.AnyType"/></this>
<to><icast><d/></icast></to>
<haxe_doc><![CDATA[This type represents the Flash `*` type, which is
actually the absense of type. It can be used as a
actually the absence of type. It can be used as a
type parameter for `flash.Vector` to represent the
native `Vector.<*>` type.]]></haxe_doc>
<meta><m n=":coreType"/></meta>
Expand Down Expand Up @@ -32052,7 +32052,7 @@
<modulus><x path="haxe.Int64"/></modulus>
</a>
</f>
<haxe_doc>Performs signed integer divison of `dividend` by `divisor`.
<haxe_doc>Performs signed integer division of `dividend` by `divisor`.
Returns `{ quotient : Int64, modulus : Int64 }`.</haxe_doc>
</divMod>
<neg public="1" get="inline" set="null" line="221" static="1">
Expand Down Expand Up @@ -32560,7 +32560,7 @@
<modulus><x path="haxe.Int64"/></modulus>
</a>
</f>
<haxe_doc>Performs signed integer divison of `dividend` by `divisor`.
<haxe_doc>Performs signed integer division of `dividend` by `divisor`.
Returns `{ quotient : Int64, modulus : Int64 }`.</haxe_doc>
</divMod>
<neg public="1" get="inline" set="null" line="221" static="1">
Expand Down Expand Up @@ -35868,7 +35868,7 @@
<m n=":enum"/>
</meta>
<haxe_doc>The field is declared on a parent type, such as:
- a super class field that is not overriden
- a super class field that is not overridden
- a forwarded abstract field</haxe_doc>
</Parent>
<StaticExtension public="1" get="inline" set="null" expr="cast 3" line="1" static="1">
Expand Down Expand Up @@ -35941,7 +35941,7 @@
<m n=":enum"/>
</meta>
<haxe_doc>The field is declared on a parent type, such as:
- a super class field that is not overriden
- a super class field that is not overridden
- a forwarded abstract field</haxe_doc>
</Parent>
<StaticExtension public="1" get="inline" set="null" expr="cast 3" line="1" static="1">
Expand Down Expand Up @@ -37966,7 +37966,7 @@
<m n=":impl"/>
<m n=":enum"/>
</meta>
<haxe_doc>Find references to the base field and all the overidding fields in the inheritance chain.</haxe_doc>
<haxe_doc>Find references to the base field and all the overriding fields in the inheritance chain.</haxe_doc>
</WithBaseAndDescendants>
<WithDescendants public="1" get="inline" set="null" expr="cast &quot;withDescendants&quot;" line="519" static="1">
<x path="haxe.display.FindReferencesKind"/>
Expand Down Expand Up @@ -37999,7 +37999,7 @@
<m n=":impl"/>
<m n=":enum"/>
</meta>
<haxe_doc>Find references to the base field and all the overidding fields in the inheritance chain.</haxe_doc>
<haxe_doc>Find references to the base field and all the overriding fields in the inheritance chain.</haxe_doc>
</WithBaseAndDescendants>
<WithDescendants public="1" get="inline" set="null" expr="cast &quot;withDescendants&quot;" line="519" static="1">
<x path="haxe.display.FindReferencesKind"/>
Expand Down Expand Up @@ -44537,7 +44537,7 @@
<exclude>
<x path="Null"><c path="Array"><c path="String"/></c></x>
<meta><m n=":optional"/></meta>
<haxe_doc>Dot paths of modules or packages to be exluded from the archive.</haxe_doc>
<haxe_doc>Dot paths of modules or packages to be excluded from the archive.</haxe_doc>
</exclude>
</a></typedef>
<typedef path="haxe.hxb.WriterConfig" params="" file="/home/runner/work/haxe/haxe/std/haxe/hxb/WriterConfig.hx"><a>
Expand Down Expand Up @@ -45243,7 +45243,7 @@
<haxe_doc>This exception is raised when reading while data is no longer available in the `haxe.io.Input`.</haxe_doc>
</class>
<enum path="haxe.io.Error" params="" file="/home/runner/work/haxe/haxe/std/haxe/io/Error.hx">
<Blocked><haxe_doc>The IO is set into nonblocking mode and some data cannot be read or written</haxe_doc></Blocked>
<Blocked><haxe_doc>The IO is set into non-blocking mode and some data cannot be read or written</haxe_doc></Blocked>
<Overflow><haxe_doc>An integer value is outside its allowed range</haxe_doc></Overflow>
<OutsideBounds><haxe_doc>An operation on Bytes is outside of its valid range</haxe_doc></OutsideBounds>
<Custom a="e">
Expand Down Expand Up @@ -52547,7 +52547,7 @@
<meta>
<x path="Null"><t path="haxe.macro.Metadata"/></x>
<meta><m n=":optional"/></meta>
<haxe_doc>Metadata associatied with the variable, if available.</haxe_doc>
<haxe_doc>Metadata associated with the variable, if available.</haxe_doc>
</meta>
<isStatic>
<x path="Null"><x path="Bool"/></x>
Expand Down Expand Up @@ -53339,7 +53339,7 @@
<t path="haxe.macro.ClassType"/>
<x path="Void"/>
</f>
<haxe_doc>select the current classe</haxe_doc>
<haxe_doc>select the current class</haxe_doc>
</setCurrentClass>
<quoteString set="method">
<f a="s">
Expand Down
Loading

0 comments on commit c00665a

Please sign in to comment.