|
@@ -22,22 +22,22 @@
|
|
|
// standard Haxe types
|
|
|
|
|
|
/**
|
|
|
- The standard Void type. Only `null` values can be of the type `Void`.
|
|
|
+ The standard `Void` type. Only `null` values can be of the type `Void`.
|
|
|
**/
|
|
|
@:coreType abstract Void { }
|
|
|
|
|
|
/**
|
|
|
- The standard Float type, this is a double-precision IEEE 64bit float.
|
|
|
+ The standard `Float` type, this is a double-precision IEEE 64bit float.
|
|
|
|
|
|
- On static targets, null cannot be assigned to Float. If this is necessary,
|
|
|
+ On static targets, `null` cannot be assigned to Float. If this is necessary,
|
|
|
`Null<Float>` can be used instead.
|
|
|
**/
|
|
|
@:coreType @:notNull @:runtimeValue abstract Float { }
|
|
|
|
|
|
/**
|
|
|
- The standard Int type. Its precision depends on the platform.
|
|
|
+ The standard `Int` type. Its precision depends on the platform.
|
|
|
|
|
|
- On static targets, null cannot be assigned to Int. If this is necessary,
|
|
|
+ On static targets, `null` cannot be assigned to `Int`. If this is necessary,
|
|
|
`Null<Int>` can be used instead.
|
|
|
**/
|
|
|
@:coreType @:notNull @:runtimeValue abstract Int to Float { }
|
|
@@ -48,64 +48,64 @@
|
|
|
|
|
|
/**
|
|
|
`Null` can be useful in two cases. In order to document some methods
|
|
|
- that accepts or can return a `null` value, or for the Flash compiler and AS3
|
|
|
- generator to distinguish between base values that can be null and others that
|
|
|
+ that accept or can return a `null` value, or for the Flash compiler and AS3
|
|
|
+ generator to distinguish between base values that can be `null` and others that
|
|
|
can't.
|
|
|
**/
|
|
|
typedef Null<T> = T
|
|
|
|
|
|
/**
|
|
|
- The standard Boolean type, which can either be true or false.
|
|
|
+ The standard Boolean type, which can either be `true` or `false`.
|
|
|
|
|
|
- On static targets, null cannot be assigned to Bool. If this is necessary,
|
|
|
+ On static targets, `null` cannot be assigned to `Bool`. If this is necessary,
|
|
|
`Null<Bool>` can be used instead.
|
|
|
**/
|
|
|
@:coreType @:notNull @:runtimeValue abstract Bool {
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- Dynamic is a special type which is compatible with all other types.
|
|
|
+ `Dynamic` is a special type which is compatible with all other types.
|
|
|
|
|
|
- Use of Dynamic should be minimized as it prevents several compiler
|
|
|
+ Use of `Dynamic` should be minimized as it prevents several compiler
|
|
|
checks and optimizations.
|
|
|
**/
|
|
|
@:coreType @:runtimeValue abstract Dynamic<T> {
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- An Iterator is a structure that permits iteration over elements of type T.
|
|
|
+ An `Iterator` is a structure that permits iteration over elements of type `T`.
|
|
|
|
|
|
- Any class with matching hasNext and next fields is considered an Iterator
|
|
|
- and can then be used e.g. in for-loops. This makes it easy to implement
|
|
|
+ Any class with matching `hasNext()` and `next()` fields is considered an `Iterator`
|
|
|
+ and can then be used e.g. in `for`-loops. This makes it easy to implement
|
|
|
custom iterators.
|
|
|
**/
|
|
|
typedef Iterator<T> = {
|
|
|
|
|
|
/**
|
|
|
- Returns false if the iteration is complete, true otherwise.
|
|
|
+ Returns `false` if the iteration is complete, `true` otherwise.
|
|
|
|
|
|
Usually iteration is considered to be complete if all elements of the
|
|
|
- underlying data structure were handled through calls to next(). However,
|
|
|
+ underlying data structure were handled through calls to `next()`. However,
|
|
|
in custom iterators any logic may be used to determine the completion
|
|
|
state.
|
|
|
**/
|
|
|
function hasNext() : Bool;
|
|
|
|
|
|
/**
|
|
|
- Returns the current item of the Iterator and advances to the next one.
|
|
|
+ Returns the current item of the `Iterator` and advances to the next one.
|
|
|
|
|
|
- This method is not required to check `hasNext` first. A call to this
|
|
|
- method while `hasNext` is false yields unspecified behavior.
|
|
|
+ This method is not required to check `hasNext()` first. A call to this
|
|
|
+ method while `hasNext()` is `false` yields unspecified behavior.
|
|
|
|
|
|
- On the other hand iterators should not require a call to `hasNext`
|
|
|
- before the first call to `next` if an element is available.
|
|
|
+ On the other hand, iterators should not require a call to `hasNext()`
|
|
|
+ before the first call to `next()` if an element is available.
|
|
|
**/
|
|
|
function next() : T;
|
|
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- An Iterable is a data structure which has an iterator() method.
|
|
|
+ An `Iterable` is a data structure which has an `iterator()` method.
|
|
|
See `Lambda` for generic functions on iterable structures.
|
|
|
**/
|
|
|
typedef Iterable<T> = {
|
|
@@ -113,7 +113,7 @@ typedef Iterable<T> = {
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- ArrayAccess is used to indicate a class that can be accessed using brackets.
|
|
|
+ `ArrayAccess` is used to indicate a class that can be accessed using brackets.
|
|
|
The type parameter represents the type of the elements stored.
|
|
|
|
|
|
This interface should be used for externs only. Haxe does not support custom
|