Skip to content

Commit

Permalink
import xml doc of development (9aa99113b3b0d71ce8df321b4a6dfdeef8fa682b)
Browse files Browse the repository at this point in the history
  • Loading branch information
@haxe-ci
haxe-ci committed Oct 15, 2024
1 parent fe869cb commit 4fdd6d6
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 9 deletions.
35 changes: 27 additions & 8 deletions xml/development/cpp.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1160,10 +1160,6 @@
<d/>
<x path="Bool"/>
</f>
<meta>
<m n=":keep"/>
<m n=":keep"/>
</meta>
<haxe_doc>Matches enum instance `e` against pattern `pattern`, returning `true` if
matching succeeded and `false` otherwise.

Expand Down Expand Up @@ -1198,10 +1194,6 @@
<d/>
<x path="Bool"/>
</f>
<meta>
<m n=":keep"/>
<m n=":keep"/>
</meta>
<haxe_doc>Matches enum instance `e` against pattern `pattern`, returning `true` if
matching succeeded and `false` otherwise.

Expand Down Expand Up @@ -1577,11 +1569,13 @@
<class path="Math" params="" file="/home/runner/work/haxe/haxe/std/Math.hx" extern="1">
<PI public="1" set="null" static="1">
<x path="Float"/>
<meta><m n=":keep"/></meta>
<haxe_doc>Represents the ratio of the circumference of a circle to its diameter,
specified by the constant, π. `PI` is approximately `3.141592653589793`.</haxe_doc>
</PI>
<NEGATIVE_INFINITY public="1" set="null" static="1">
<x path="Float"/>
<meta><m n=":keep"/></meta>
<haxe_doc>A special `Float` constant which denotes negative infinity.

For example, this is the result of `-1.0 / 0.0`.
Expand All @@ -1594,6 +1588,7 @@
</NEGATIVE_INFINITY>
<POSITIVE_INFINITY public="1" set="null" static="1">
<x path="Float"/>
<meta><m n=":keep"/></meta>
<haxe_doc>A special `Float` constant which denotes positive infinity.

For example, this is the result of `1.0 / 0.0`.
Expand All @@ -1606,6 +1601,7 @@
</POSITIVE_INFINITY>
<NaN public="1" set="null" static="1">
<x path="Float"/>
<meta><m n=":keep"/></meta>
<haxe_doc>A special `Float` constant which denotes an invalid number.

`NaN` stands for "Not a Number". It occurs when a mathematically incorrect
Expand All @@ -1624,6 +1620,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the absolute value of `v`.

- If `v` is positive or `0`, the result is unchanged. Otherwise the result is `-v`.
Expand All @@ -1636,6 +1633,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the smaller of values `a` and `b`.

- If `a` or `b` are `NaN`, the result is `NaN`.
Expand All @@ -1648,6 +1646,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the greater of values `a` and `b`.

- If `a` or `b` are `NaN`, the result is `NaN`.
Expand All @@ -1659,6 +1658,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the trigonometric sine of the specified angle `v`, in radians.

If `v` is `NaN` or infinite, the result is `NaN`.</haxe_doc>
Expand All @@ -1668,6 +1668,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the trigonometric cosine of the specified angle `v`, in radians.

If `v` is `NaN` or infinite, the result is `NaN`.</haxe_doc>
Expand All @@ -1677,6 +1678,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the trigonometric tangent of the specified angle `v`, in radians.

If `v` is `NaN` or infinite, the result is `NaN`.</haxe_doc>
Expand All @@ -1686,6 +1688,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the trigonometric arc of the specified angle `v`, in radians.

If `v` is `NaN` or infinite, the result is `NaN`.</haxe_doc>
Expand All @@ -1695,6 +1698,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the trigonometric arc cosine of the specified angle `v`,
in radians.

Expand All @@ -1705,6 +1709,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the trigonometric arc tangent of the specified angle `v`,
in radians.

Expand All @@ -1716,6 +1721,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the trigonometric arc tangent whose tangent is the quotient of
two specified numbers, in radians.

Expand All @@ -1727,6 +1733,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns Euler's number, raised to the power of `v`.

`exp(1.0)` is approximately `2.718281828459`.
Expand All @@ -1740,6 +1747,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the natural logarithm of `v`.

This is the mathematical inverse operation of exp,
Expand All @@ -1755,13 +1763,15 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns a specified base `v` raised to the specified power `exp`.</haxe_doc>
</pow>
<sqrt public="1" set="method" static="1">
<f a="v">
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the square root of `v`.

- If `v` is negative (including `NEGATIVE_INFINITY`) or `NaN`, the result is `NaN`.
Expand All @@ -1773,6 +1783,7 @@
<x path="Float"/>
<x path="Int"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Rounds `v` to the nearest integer value.

Ties are rounded up, so that `0.5` becomes `1` and `-0.5` becomes `0`.
Expand All @@ -1785,6 +1796,7 @@
<x path="Float"/>
<x path="Int"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the largest integer value that is not greater than `v`.

If `v` is outside of the signed `Int32` range, or is `NaN`, `NEGATIVE_INFINITY`
Expand All @@ -1795,13 +1807,15 @@
<x path="Float"/>
<x path="Int"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the smallest integer value that is not less than `v`.

If `v` is outside of the signed `Int32` range, or is `NaN`, `NEGATIVE_INFINITY`
or `POSITIVE_INFINITY`, the result is unspecified.</haxe_doc>
</ceil>
<random public="1" set="method" static="1">
<f a=""><x path="Float"/></f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns a pseudo-random number which is greater than or equal to `0.0`,
and less than `1.0`.</haxe_doc>
</random>
Expand All @@ -1810,6 +1824,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the largest integer value that is not greater than `v`, as a `Float`.

If `v` is is `NaN`, `NEGATIVE_INFINITY` or `POSITIVE_INFINITY`,
Expand All @@ -1820,6 +1835,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Returns the smallest integer value that is not less than `v`, as a `Float`.

If `v` is is `NaN`, `NEGATIVE_INFINITY` or `POSITIVE_INFINITY`,
Expand All @@ -1830,6 +1846,7 @@
<x path="Float"/>
<x path="Float"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Rounds `v` to the nearest integer value, as a Float.

Ties are rounded up, so that `0.5` becomes `1` and `-0.5` becomes `0`.
Expand All @@ -1842,6 +1859,7 @@
<x path="Float"/>
<x path="Bool"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Tells if `f` is a finite number.

If `f` is `POSITIVE_INFINITY`, `NEGATIVE_INFINITY` or `NaN`, the result
Expand All @@ -1852,6 +1870,7 @@
<x path="Float"/>
<x path="Bool"/>
</f>
<meta><m n=":keep"/></meta>
<haxe_doc>Tells if `f` is `Math.NaN`.

If `f` is `NaN`, the result is `true`, otherwise the result is `false`.
Expand Down
2 changes: 1 addition & 1 deletion xml/development/info.json
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"commit": "39aceb1e45f9bdc9f5a7e07aa891f72a51a0029b",
"commit": "9aa99113b3b0d71ce8df321b4a6dfdeef8fa682b",
"branch": "development"
}

0 comments on commit 4fdd6d6

Please sign in to comment.