From ab7886cfd4c47b0785d39d5fada171101fe951c8 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 16 Mar 2022 23:01:02 +0100 Subject: [PATCH] Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. --- doc_classes/VisualScript.xml | 2 +- doc_classes/VisualScriptBasicTypeConstant.xml | 2 +- doc_classes/VisualScriptBuiltinFunc.xml | 2 +- doc_classes/VisualScriptClassConstant.xml | 2 +- doc_classes/VisualScriptComment.xml | 2 +- doc_classes/VisualScriptComposeArray.xml | 2 +- doc_classes/VisualScriptCondition.xml | 2 +- doc_classes/VisualScriptConstant.xml | 2 +- doc_classes/VisualScriptConstructor.xml | 2 +- doc_classes/VisualScriptCustomNode.xml | 2 +- doc_classes/VisualScriptDeconstruct.xml | 2 +- doc_classes/VisualScriptEditor.xml | 2 +- doc_classes/VisualScriptEmitSignal.xml | 2 +- doc_classes/VisualScriptEngineSingleton.xml | 2 +- doc_classes/VisualScriptExpression.xml | 2 +- doc_classes/VisualScriptFunction.xml | 2 +- doc_classes/VisualScriptFunctionCall.xml | 2 +- doc_classes/VisualScriptFunctionState.xml | 2 +- doc_classes/VisualScriptGlobalConstant.xml | 2 +- doc_classes/VisualScriptIndexGet.xml | 2 +- doc_classes/VisualScriptIndexSet.xml | 2 +- doc_classes/VisualScriptInputAction.xml | 2 +- doc_classes/VisualScriptIterator.xml | 2 +- doc_classes/VisualScriptLists.xml | 2 +- doc_classes/VisualScriptLocalVar.xml | 2 +- doc_classes/VisualScriptLocalVarSet.xml | 2 +- doc_classes/VisualScriptMathConstant.xml | 2 +- doc_classes/VisualScriptNode.xml | 2 +- doc_classes/VisualScriptOperator.xml | 2 +- doc_classes/VisualScriptPreload.xml | 2 +- doc_classes/VisualScriptPropertyGet.xml | 2 +- doc_classes/VisualScriptPropertySet.xml | 2 +- doc_classes/VisualScriptResourcePath.xml | 2 +- doc_classes/VisualScriptReturn.xml | 2 +- doc_classes/VisualScriptSceneNode.xml | 2 +- doc_classes/VisualScriptSceneTree.xml | 2 +- doc_classes/VisualScriptSelect.xml | 2 +- doc_classes/VisualScriptSelf.xml | 2 +- doc_classes/VisualScriptSequence.xml | 2 +- doc_classes/VisualScriptSubCall.xml | 2 +- doc_classes/VisualScriptSwitch.xml | 2 +- doc_classes/VisualScriptTypeCast.xml | 2 +- doc_classes/VisualScriptVariableGet.xml | 2 +- doc_classes/VisualScriptVariableSet.xml | 2 +- doc_classes/VisualScriptWhile.xml | 2 +- doc_classes/VisualScriptYield.xml | 2 +- doc_classes/VisualScriptYieldSignal.xml | 2 +- 47 files changed, 47 insertions(+), 47 deletions(-) diff --git a/doc_classes/VisualScript.xml b/doc_classes/VisualScript.xml index 889ea17..ea3f1cc 100644 --- a/doc_classes/VisualScript.xml +++ b/doc_classes/VisualScript.xml @@ -1,5 +1,5 @@ - + A script implemented in the Visual Script programming environment. diff --git a/doc_classes/VisualScriptBasicTypeConstant.xml b/doc_classes/VisualScriptBasicTypeConstant.xml index 0546600..4188d3f 100644 --- a/doc_classes/VisualScriptBasicTypeConstant.xml +++ b/doc_classes/VisualScriptBasicTypeConstant.xml @@ -1,5 +1,5 @@ - + A Visual Script node representing a constant from the base types. diff --git a/doc_classes/VisualScriptBuiltinFunc.xml b/doc_classes/VisualScriptBuiltinFunc.xml index bc88b5d..ff99d46 100644 --- a/doc_classes/VisualScriptBuiltinFunc.xml +++ b/doc_classes/VisualScriptBuiltinFunc.xml @@ -1,5 +1,5 @@ - + A Visual Script node used to call built-in functions. diff --git a/doc_classes/VisualScriptClassConstant.xml b/doc_classes/VisualScriptClassConstant.xml index dd513dc..9202fd4 100644 --- a/doc_classes/VisualScriptClassConstant.xml +++ b/doc_classes/VisualScriptClassConstant.xml @@ -1,5 +1,5 @@ - + Gets a constant from a given class. diff --git a/doc_classes/VisualScriptComment.xml b/doc_classes/VisualScriptComment.xml index de55de3..38fa12f 100644 --- a/doc_classes/VisualScriptComment.xml +++ b/doc_classes/VisualScriptComment.xml @@ -1,5 +1,5 @@ - + A Visual Script node used to annotate the script. diff --git a/doc_classes/VisualScriptComposeArray.xml b/doc_classes/VisualScriptComposeArray.xml index d354bab..10b906d 100644 --- a/doc_classes/VisualScriptComposeArray.xml +++ b/doc_classes/VisualScriptComposeArray.xml @@ -1,5 +1,5 @@ - + A Visual Script Node used to create array from a list of items. diff --git a/doc_classes/VisualScriptCondition.xml b/doc_classes/VisualScriptCondition.xml index 2076912..4305fa1 100644 --- a/doc_classes/VisualScriptCondition.xml +++ b/doc_classes/VisualScriptCondition.xml @@ -1,5 +1,5 @@ - + A Visual Script node which branches the flow. diff --git a/doc_classes/VisualScriptConstant.xml b/doc_classes/VisualScriptConstant.xml index 35d58c5..c642dcc 100644 --- a/doc_classes/VisualScriptConstant.xml +++ b/doc_classes/VisualScriptConstant.xml @@ -1,5 +1,5 @@ - + Gets a contant's value. diff --git a/doc_classes/VisualScriptConstructor.xml b/doc_classes/VisualScriptConstructor.xml index 5f95bfe..6f37604 100644 --- a/doc_classes/VisualScriptConstructor.xml +++ b/doc_classes/VisualScriptConstructor.xml @@ -1,5 +1,5 @@ - + A Visual Script node which calls a base type constructor. diff --git a/doc_classes/VisualScriptCustomNode.xml b/doc_classes/VisualScriptCustomNode.xml index 25bfc20..0e9dce0 100644 --- a/doc_classes/VisualScriptCustomNode.xml +++ b/doc_classes/VisualScriptCustomNode.xml @@ -1,5 +1,5 @@ - + A scripted Visual Script node. diff --git a/doc_classes/VisualScriptDeconstruct.xml b/doc_classes/VisualScriptDeconstruct.xml index 797aa51..552d62e 100644 --- a/doc_classes/VisualScriptDeconstruct.xml +++ b/doc_classes/VisualScriptDeconstruct.xml @@ -1,5 +1,5 @@ - + A Visual Script node which deconstructs a base type instance into its parts. diff --git a/doc_classes/VisualScriptEditor.xml b/doc_classes/VisualScriptEditor.xml index de160d4..c4f5f17 100644 --- a/doc_classes/VisualScriptEditor.xml +++ b/doc_classes/VisualScriptEditor.xml @@ -1,5 +1,5 @@ - + diff --git a/doc_classes/VisualScriptEmitSignal.xml b/doc_classes/VisualScriptEmitSignal.xml index 1dca916..6b70096 100644 --- a/doc_classes/VisualScriptEmitSignal.xml +++ b/doc_classes/VisualScriptEmitSignal.xml @@ -1,5 +1,5 @@ - + Emits a specified signal. diff --git a/doc_classes/VisualScriptEngineSingleton.xml b/doc_classes/VisualScriptEngineSingleton.xml index a391001..397f112 100644 --- a/doc_classes/VisualScriptEngineSingleton.xml +++ b/doc_classes/VisualScriptEngineSingleton.xml @@ -1,5 +1,5 @@ - + A Visual Script node returning a singleton from [@GlobalScope]. diff --git a/doc_classes/VisualScriptExpression.xml b/doc_classes/VisualScriptExpression.xml index d180197..03e0a55 100644 --- a/doc_classes/VisualScriptExpression.xml +++ b/doc_classes/VisualScriptExpression.xml @@ -1,5 +1,5 @@ - + A Visual Script node that can execute a custom expression. diff --git a/doc_classes/VisualScriptFunction.xml b/doc_classes/VisualScriptFunction.xml index d9e68b1..980981c 100644 --- a/doc_classes/VisualScriptFunction.xml +++ b/doc_classes/VisualScriptFunction.xml @@ -1,5 +1,5 @@ - + A Visual Script node representing a function. diff --git a/doc_classes/VisualScriptFunctionCall.xml b/doc_classes/VisualScriptFunctionCall.xml index 7431958..1ea8570 100644 --- a/doc_classes/VisualScriptFunctionCall.xml +++ b/doc_classes/VisualScriptFunctionCall.xml @@ -1,5 +1,5 @@ - + A Visual Script node for calling a function. diff --git a/doc_classes/VisualScriptFunctionState.xml b/doc_classes/VisualScriptFunctionState.xml index 5d36d54..fcdd06d 100644 --- a/doc_classes/VisualScriptFunctionState.xml +++ b/doc_classes/VisualScriptFunctionState.xml @@ -1,5 +1,5 @@ - + A Visual Script node representing a function state. diff --git a/doc_classes/VisualScriptGlobalConstant.xml b/doc_classes/VisualScriptGlobalConstant.xml index 28134bf..01adb79 100644 --- a/doc_classes/VisualScriptGlobalConstant.xml +++ b/doc_classes/VisualScriptGlobalConstant.xml @@ -1,5 +1,5 @@ - + A Visual Script node returning a constant from [@GlobalScope]. diff --git a/doc_classes/VisualScriptIndexGet.xml b/doc_classes/VisualScriptIndexGet.xml index cf46fba..5cc314b 100644 --- a/doc_classes/VisualScriptIndexGet.xml +++ b/doc_classes/VisualScriptIndexGet.xml @@ -1,5 +1,5 @@ - + A Visual Script node for getting a value from an array or a dictionary. diff --git a/doc_classes/VisualScriptIndexSet.xml b/doc_classes/VisualScriptIndexSet.xml index 68b41c2..4c2b07c 100644 --- a/doc_classes/VisualScriptIndexSet.xml +++ b/doc_classes/VisualScriptIndexSet.xml @@ -1,5 +1,5 @@ - + A Visual Script node for setting a value in an array or a dictionary. diff --git a/doc_classes/VisualScriptInputAction.xml b/doc_classes/VisualScriptInputAction.xml index b15009a..914ee06 100644 --- a/doc_classes/VisualScriptInputAction.xml +++ b/doc_classes/VisualScriptInputAction.xml @@ -1,5 +1,5 @@ - + A Visual Script node returning a state of an action. diff --git a/doc_classes/VisualScriptIterator.xml b/doc_classes/VisualScriptIterator.xml index 4419e61..e7234f6 100644 --- a/doc_classes/VisualScriptIterator.xml +++ b/doc_classes/VisualScriptIterator.xml @@ -1,5 +1,5 @@ - + Steps through items in a given input. diff --git a/doc_classes/VisualScriptLists.xml b/doc_classes/VisualScriptLists.xml index 6756149..dd94e78 100644 --- a/doc_classes/VisualScriptLists.xml +++ b/doc_classes/VisualScriptLists.xml @@ -1,5 +1,5 @@ - + A Visual Script virtual class for in-graph editable nodes. diff --git a/doc_classes/VisualScriptLocalVar.xml b/doc_classes/VisualScriptLocalVar.xml index fcded49..b53ff4d 100644 --- a/doc_classes/VisualScriptLocalVar.xml +++ b/doc_classes/VisualScriptLocalVar.xml @@ -1,5 +1,5 @@ - + Gets a local variable's value. diff --git a/doc_classes/VisualScriptLocalVarSet.xml b/doc_classes/VisualScriptLocalVarSet.xml index 9737cb2..8b47936 100644 --- a/doc_classes/VisualScriptLocalVarSet.xml +++ b/doc_classes/VisualScriptLocalVarSet.xml @@ -1,5 +1,5 @@ - + Changes a local variable's value. diff --git a/doc_classes/VisualScriptMathConstant.xml b/doc_classes/VisualScriptMathConstant.xml index 5bf90e8..f30faff 100644 --- a/doc_classes/VisualScriptMathConstant.xml +++ b/doc_classes/VisualScriptMathConstant.xml @@ -1,5 +1,5 @@ - + Commonly used mathematical constants. diff --git a/doc_classes/VisualScriptNode.xml b/doc_classes/VisualScriptNode.xml index fb9b88a..4cec95e 100644 --- a/doc_classes/VisualScriptNode.xml +++ b/doc_classes/VisualScriptNode.xml @@ -1,5 +1,5 @@ - + A node which is part of a [VisualScript]. diff --git a/doc_classes/VisualScriptOperator.xml b/doc_classes/VisualScriptOperator.xml index 21a88fa..53cf8fe 100644 --- a/doc_classes/VisualScriptOperator.xml +++ b/doc_classes/VisualScriptOperator.xml @@ -1,5 +1,5 @@ - + A Visual Script node that performs an operation on two values. diff --git a/doc_classes/VisualScriptPreload.xml b/doc_classes/VisualScriptPreload.xml index f22e4c3..3b52c44 100644 --- a/doc_classes/VisualScriptPreload.xml +++ b/doc_classes/VisualScriptPreload.xml @@ -1,5 +1,5 @@ - + Creates a new [Resource] or loads one from the filesystem. diff --git a/doc_classes/VisualScriptPropertyGet.xml b/doc_classes/VisualScriptPropertyGet.xml index 6e475f2..8270b09 100644 --- a/doc_classes/VisualScriptPropertyGet.xml +++ b/doc_classes/VisualScriptPropertyGet.xml @@ -1,5 +1,5 @@ - + A Visual Script node returning a value of a property from an [Object]. diff --git a/doc_classes/VisualScriptPropertySet.xml b/doc_classes/VisualScriptPropertySet.xml index a113aa4..24ec5ac 100644 --- a/doc_classes/VisualScriptPropertySet.xml +++ b/doc_classes/VisualScriptPropertySet.xml @@ -1,5 +1,5 @@ - + A Visual Script node that sets a property of an [Object]. diff --git a/doc_classes/VisualScriptResourcePath.xml b/doc_classes/VisualScriptResourcePath.xml index c5a3654..17d5921 100644 --- a/doc_classes/VisualScriptResourcePath.xml +++ b/doc_classes/VisualScriptResourcePath.xml @@ -1,5 +1,5 @@ - + diff --git a/doc_classes/VisualScriptReturn.xml b/doc_classes/VisualScriptReturn.xml index 55196a5..5213fbe 100644 --- a/doc_classes/VisualScriptReturn.xml +++ b/doc_classes/VisualScriptReturn.xml @@ -1,5 +1,5 @@ - + Exits a function and returns an optional value. diff --git a/doc_classes/VisualScriptSceneNode.xml b/doc_classes/VisualScriptSceneNode.xml index ca49f93..c6857b0 100644 --- a/doc_classes/VisualScriptSceneNode.xml +++ b/doc_classes/VisualScriptSceneNode.xml @@ -1,5 +1,5 @@ - + Node reference. diff --git a/doc_classes/VisualScriptSceneTree.xml b/doc_classes/VisualScriptSceneTree.xml index ae06298..8a439eb 100644 --- a/doc_classes/VisualScriptSceneTree.xml +++ b/doc_classes/VisualScriptSceneTree.xml @@ -1,5 +1,5 @@ - + A Visual Script node for accessing [SceneTree] methods. diff --git a/doc_classes/VisualScriptSelect.xml b/doc_classes/VisualScriptSelect.xml index ba1cfef..a215898 100644 --- a/doc_classes/VisualScriptSelect.xml +++ b/doc_classes/VisualScriptSelect.xml @@ -1,5 +1,5 @@ - + Chooses between two input values. diff --git a/doc_classes/VisualScriptSelf.xml b/doc_classes/VisualScriptSelf.xml index b4bb44c..5cde305 100644 --- a/doc_classes/VisualScriptSelf.xml +++ b/doc_classes/VisualScriptSelf.xml @@ -1,5 +1,5 @@ - + Outputs a reference to the current instance. diff --git a/doc_classes/VisualScriptSequence.xml b/doc_classes/VisualScriptSequence.xml index eb237d2..538e3c2 100644 --- a/doc_classes/VisualScriptSequence.xml +++ b/doc_classes/VisualScriptSequence.xml @@ -1,5 +1,5 @@ - + Executes a series of Sequence ports. diff --git a/doc_classes/VisualScriptSubCall.xml b/doc_classes/VisualScriptSubCall.xml index 735d3e5..d312205 100644 --- a/doc_classes/VisualScriptSubCall.xml +++ b/doc_classes/VisualScriptSubCall.xml @@ -1,5 +1,5 @@ - + Calls a method called [code]_subcall[/code] in this object. diff --git a/doc_classes/VisualScriptSwitch.xml b/doc_classes/VisualScriptSwitch.xml index 9959c0a..5054ac7 100644 --- a/doc_classes/VisualScriptSwitch.xml +++ b/doc_classes/VisualScriptSwitch.xml @@ -1,5 +1,5 @@ - + Branches program flow based on a given input's value. diff --git a/doc_classes/VisualScriptTypeCast.xml b/doc_classes/VisualScriptTypeCast.xml index 9a34812..317edf6 100644 --- a/doc_classes/VisualScriptTypeCast.xml +++ b/doc_classes/VisualScriptTypeCast.xml @@ -1,5 +1,5 @@ - + A Visual Script node that casts the given value to another type. diff --git a/doc_classes/VisualScriptVariableGet.xml b/doc_classes/VisualScriptVariableGet.xml index 04f3a16..62ba81d 100644 --- a/doc_classes/VisualScriptVariableGet.xml +++ b/doc_classes/VisualScriptVariableGet.xml @@ -1,5 +1,5 @@ - + Gets a variable's value. diff --git a/doc_classes/VisualScriptVariableSet.xml b/doc_classes/VisualScriptVariableSet.xml index 374ff34..66e4dce 100644 --- a/doc_classes/VisualScriptVariableSet.xml +++ b/doc_classes/VisualScriptVariableSet.xml @@ -1,5 +1,5 @@ - + Changes a variable's value. diff --git a/doc_classes/VisualScriptWhile.xml b/doc_classes/VisualScriptWhile.xml index d9adc7b..8ef22c6 100644 --- a/doc_classes/VisualScriptWhile.xml +++ b/doc_classes/VisualScriptWhile.xml @@ -1,5 +1,5 @@ - + Conditional loop. diff --git a/doc_classes/VisualScriptYield.xml b/doc_classes/VisualScriptYield.xml index fb880e9..05fa68a 100644 --- a/doc_classes/VisualScriptYield.xml +++ b/doc_classes/VisualScriptYield.xml @@ -1,5 +1,5 @@ - + A Visual Script node used to pause a function execution. diff --git a/doc_classes/VisualScriptYieldSignal.xml b/doc_classes/VisualScriptYieldSignal.xml index cf7cf5f..6adb6bd 100644 --- a/doc_classes/VisualScriptYieldSignal.xml +++ b/doc_classes/VisualScriptYieldSignal.xml @@ -1,5 +1,5 @@ - + A Visual Script node yielding for a signal.