From 8bc6c865e554a791445773f70d14ac9fc9c635c4 Mon Sep 17 00:00:00 2001 From: Haxe CI Bot Date: Tue, 7 Nov 2023 10:52:55 +0000 Subject: [PATCH] import xml doc of development (e328c44d78557db974ddb7f0a5604b1fa8ac432b) --- xml/development/info.json | 2 +- xml/development/macro.xml | 132 +++++++++++++++++++------------------- xml/development/neko.xml | 132 +++++++++++++++++++------------------- 3 files changed, 135 insertions(+), 131 deletions(-) diff --git a/xml/development/info.json b/xml/development/info.json index cf10c09222de..ed2dbf711746 100644 --- a/xml/development/info.json +++ b/xml/development/info.json @@ -1,4 +1,4 @@ { - "commit": "f5fcc4572ed91c31ba4e979deb70a49949e52d2a", + "commit": "e328c44d78557db974ddb7f0a5604b1fa8ac432b", "branch": "development" } diff --git a/xml/development/macro.xml b/xml/development/macro.xml index 04140628634c..25efbe01e34b 100644 --- a/xml/development/macro.xml +++ b/xml/development/macro.xml @@ -37926,7 +37926,7 @@ Check if compiler is past initializations macros or not. When it is, configuration phase is over and parsing/typing can start. - + @@ -37937,9 +37937,11 @@ declared class path has priority. If a class path was declared relative, this method returns the relative - file path. Otherwise it returns the absolute file path. + file path. Otherwise it returns the absolute file path. + + If no type can be found, an exception of type `String` is thrown. - + Returns an `Array` of current class paths in the order of their declaration. @@ -37947,24 +37949,24 @@ Modifying the returned array has no effect on the compiler. Class paths can be added using `haxe.macro.Compiler.addClassPath`. - + Check if current display position is within `pos`. - - + + Returns the position at which the macro was called. - + Get the call stack (excluding the call to `Context.getMacroStack()` that led to current macro. - + Returns the type which is expected at the place the macro is called. @@ -37974,49 +37976,49 @@ Might return `null` if no specific type is expected or if the calling macro is not an expression-macro. - + Returns the call arguments that lead to the invocation of the current `@:genericBuild` macro, if available. Returns `null` if the current macro is not a `@:genericBuild` macro. - + Returns the current class in which the macro was called. If no such class exists, `null` is returned. - + Returns the current module path in/on which the macro was called. - + Returns the current type in/on which the macro was called. If no such type exists, `null` is returned. - + Returns the name of the method from which the macro was called. If no such method exists, `null` is returned. - + Returns an `Array` of classes which are available for `using` usage in the context the macro was called. Modifying the returned array has no effect on the compiler. - + Returns an `Array` of all imports in the context the macro was called. Modifying the returned array has no effect on the compiler. - + @@ -38030,7 +38032,7 @@ Modifying the returned map has no effect on the compiler. - + @@ -38038,7 +38040,7 @@ Similar to `getLocalVars`, but returns elements of type `TVar` instead of `Type`. - + @@ -38050,10 +38052,10 @@ @see https://haxe.org/manual/lf-condition-compilation.html - + - + Returns the value defined for the conditional compilation flag `key`. @@ -38066,7 +38068,7 @@ @see https://haxe.org/manual/lf-condition-compilation.html - + @@ -38080,7 +38082,7 @@ @see https://haxe.org/manual/lf-condition-compilation.html - + @@ -38096,7 +38098,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38113,7 +38115,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + Returns the typed expression of the call to the main function. @@ -38121,7 +38123,7 @@ made outside a function passed to `haxe.macro.Context.onGenerate` or `haxe.macro.Context.onAfterGenerate` will return `null`. - + Returns an array of module types to be generated in the output. @@ -38134,7 +38136,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38147,7 +38149,7 @@ The provided `Position` `pos` is used for all generated inner AST nodes. - + @@ -38156,7 +38158,7 @@ Similar to `parse`, but error positions are reported within the provided String `expr`. - + @@ -38170,14 +38172,14 @@ The provided `Position` `pos` is used for all generated inner AST nodes. - + Returns a hashed MD5 signature of value `v`. - + @@ -38202,7 +38204,7 @@ *Note*: the callback is still invoked when generation is disabled with `--no-output`. - + @@ -38215,7 +38217,7 @@ *Note*: the callback is still invoked when generation is disabled with `--no-output`. - + @@ -38230,7 +38232,7 @@ It is possible to define new types in the callback, in which case it will be called again with the new types as argument. - + @@ -38242,7 +38244,7 @@ your initalization macros, to properly separate configuration phase and actual typing. - + @@ -38257,7 +38259,7 @@ expected type. If it returns `null`, the type is considered to still not exist. - + @@ -38271,7 +38273,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38288,7 +38290,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38304,7 +38306,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38318,7 +38320,7 @@ The difference with `resolveType` is that it only performs type resolution, it does not build any type or trigger macros. - + @@ -38327,7 +38329,7 @@ See `haxe.macro.TypeTools.toComplexType` for details. - + @@ -38339,7 +38341,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38353,7 +38355,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38368,7 +38370,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38379,7 +38381,7 @@ Returns the information stored in `Position` `p`. - + @@ -38390,7 +38392,7 @@ Builds a `Position` from `inf`. - + @@ -38400,7 +38402,7 @@ Modifying the returned map has no effect on the compilation, use `haxe.macro.Context.addResource` to add new resources to the compilation unit. - + @@ -38417,13 +38419,13 @@ that module is reused. If this resource concerns several modules, prefix its name with a `$` sign, this will bind it to the macro module instead. - + Returns an `Array` of fields of the class which is to be built. This is only defined for `@:build/@:autoBuild` macros. - + @@ -38439,7 +38441,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + Creates and returns a new instance of monomorph (`TMono`) type. @@ -38450,7 +38452,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38469,7 +38471,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38482,7 +38484,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38502,7 +38504,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38525,7 +38527,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38540,7 +38542,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38558,7 +38560,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38576,7 +38578,7 @@ stopTimer(); ``` - + @@ -38595,7 +38597,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38622,7 +38624,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -38630,14 +38632,14 @@ - + - + @@ -38650,21 +38652,21 @@ haxe.macro.PositionTools - + - + - + haxe.macro.Compiler - + diff --git a/xml/development/neko.xml b/xml/development/neko.xml index 1561bda2eecc..797c3f9d9054 100644 --- a/xml/development/neko.xml +++ b/xml/development/neko.xml @@ -28852,7 +28852,7 @@ Check if compiler is past initializations macros or not. When it is, configuration phase is over and parsing/typing can start. - + @@ -28863,9 +28863,11 @@ declared class path has priority. If a class path was declared relative, this method returns the relative - file path. Otherwise it returns the absolute file path. + file path. Otherwise it returns the absolute file path. + + If no type can be found, an exception of type `String` is thrown. - + Returns an `Array` of current class paths in the order of their declaration. @@ -28873,24 +28875,24 @@ Modifying the returned array has no effect on the compiler. Class paths can be added using `haxe.macro.Compiler.addClassPath`. - + Check if current display position is within `pos`. - - + + Returns the position at which the macro was called. - + Get the call stack (excluding the call to `Context.getMacroStack()` that led to current macro. - + Returns the type which is expected at the place the macro is called. @@ -28900,49 +28902,49 @@ Might return `null` if no specific type is expected or if the calling macro is not an expression-macro. - + Returns the call arguments that lead to the invocation of the current `@:genericBuild` macro, if available. Returns `null` if the current macro is not a `@:genericBuild` macro. - + Returns the current class in which the macro was called. If no such class exists, `null` is returned. - + Returns the current module path in/on which the macro was called. - + Returns the current type in/on which the macro was called. If no such type exists, `null` is returned. - + Returns the name of the method from which the macro was called. If no such method exists, `null` is returned. - + Returns an `Array` of classes which are available for `using` usage in the context the macro was called. Modifying the returned array has no effect on the compiler. - + Returns an `Array` of all imports in the context the macro was called. Modifying the returned array has no effect on the compiler. - + @@ -28956,7 +28958,7 @@ Modifying the returned map has no effect on the compiler. - + @@ -28964,7 +28966,7 @@ Similar to `getLocalVars`, but returns elements of type `TVar` instead of `Type`. - + @@ -28976,10 +28978,10 @@ @see https://haxe.org/manual/lf-condition-compilation.html - + - + Returns the value defined for the conditional compilation flag `key`. @@ -28992,7 +28994,7 @@ @see https://haxe.org/manual/lf-condition-compilation.html - + @@ -29006,7 +29008,7 @@ @see https://haxe.org/manual/lf-condition-compilation.html - + @@ -29022,7 +29024,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29039,7 +29041,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + Returns the typed expression of the call to the main function. @@ -29047,7 +29049,7 @@ made outside a function passed to `haxe.macro.Context.onGenerate` or `haxe.macro.Context.onAfterGenerate` will return `null`. - + Returns an array of module types to be generated in the output. @@ -29060,7 +29062,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29073,7 +29075,7 @@ The provided `Position` `pos` is used for all generated inner AST nodes. - + @@ -29082,7 +29084,7 @@ Similar to `parse`, but error positions are reported within the provided String `expr`. - + @@ -29096,14 +29098,14 @@ The provided `Position` `pos` is used for all generated inner AST nodes. - + Returns a hashed MD5 signature of value `v`. - + @@ -29128,7 +29130,7 @@ *Note*: the callback is still invoked when generation is disabled with `--no-output`. - + @@ -29141,7 +29143,7 @@ *Note*: the callback is still invoked when generation is disabled with `--no-output`. - + @@ -29156,7 +29158,7 @@ It is possible to define new types in the callback, in which case it will be called again with the new types as argument. - + @@ -29168,7 +29170,7 @@ your initalization macros, to properly separate configuration phase and actual typing. - + @@ -29183,7 +29185,7 @@ expected type. If it returns `null`, the type is considered to still not exist. - + @@ -29197,7 +29199,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29214,7 +29216,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29230,7 +29232,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29244,7 +29246,7 @@ The difference with `resolveType` is that it only performs type resolution, it does not build any type or trigger macros. - + @@ -29253,7 +29255,7 @@ See `haxe.macro.TypeTools.toComplexType` for details. - + @@ -29265,7 +29267,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29279,7 +29281,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29294,7 +29296,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29305,7 +29307,7 @@ Returns the information stored in `Position` `p`. - + @@ -29316,7 +29318,7 @@ Builds a `Position` from `inf`. - + @@ -29326,7 +29328,7 @@ Modifying the returned map has no effect on the compilation, use `haxe.macro.Context.addResource` to add new resources to the compilation unit. - + @@ -29343,13 +29345,13 @@ that module is reused. If this resource concerns several modules, prefix its name with a `$` sign, this will bind it to the macro module instead. - + Returns an `Array` of fields of the class which is to be built. This is only defined for `@:build/@:autoBuild` macros. - + @@ -29365,7 +29367,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + Creates and returns a new instance of monomorph (`TMono`) type. @@ -29376,7 +29378,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29395,7 +29397,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29408,7 +29410,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29428,7 +29430,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29451,7 +29453,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29466,7 +29468,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29484,7 +29486,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29502,7 +29504,7 @@ stopTimer(); ``` - + @@ -29521,7 +29523,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29548,7 +29550,7 @@ cause compilation server issues. Use `Context.onAfterInitMacros` to run your code once typer is ready to be used. - + @@ -29556,14 +29558,14 @@ - + - + @@ -29576,21 +29578,21 @@ haxe.macro.PositionTools - + - + - + haxe.macro.Compiler - +