hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Markup fixes for enums and constants

Browse source
This commit is contained in:
Rémi Verschelde 2019-12-06 23:09:20 +01:00
parent c5c320412f
commit 4eff13d768
50 changed files with 167 additions and 158 deletions
Download patch file Download diff file Expand all files Collapse all files

6
modules/gdscript/doc_classes/@GDScript.xml
View file

@ -208,7 +208,7 @@
<argument index="1" name="type" type="int">
</argument>
<description>
Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum [code]TYPE_*[/code] in [@GlobalScope].
Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the [enum Variant.Type] values.
[codeblock]
a = Vector2(1, 0)
# Prints 1
@ -1217,7 +1217,7 @@
<argument index="0" name="what" type="Variant">
</argument>
<description>
Returns the internal type of the given Variant object, using the [code]TYPE_*[/code] enum in [@GlobalScope].
Returns the internal type of the given Variant object, using the [enum Variant.Type] values.
[codeblock]
p = parse_json('["a", "b", "c"]')
if typeof(p) == TYPE_ARRAY:
@ -1233,7 +1233,7 @@
<argument index="0" name="json" type="String">
</argument>
<description>
Checks that [code]json[/code] is valid JSON data. Returns empty string if valid. Returns error message if not valid.
Checks that [code]json[/code] is valid JSON data. Returns an empty string if valid, or an error message otherwise.
[codeblock]
j = to_json([1, 2, 3])
v = validate_json(j)

10
modules/visual_script/doc_classes/VisualScriptCustomNode.xml
View file

@ -45,7 +45,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the specified input port's type. See the [code]TYPE_*[/code] enum in [@GlobalScope].
Return the specified input port's type. See the [enum Variant.Type] values.
</description>
</method>
<method name="_get_output_sequence_port_count" qualifiers="virtual">
@ -86,7 +86,7 @@
<argument index="0" name="idx" type="int">
</argument>
<description>
Return the specified output's type. See the [code]TYPE_*[/code] enum in [@GlobalScope].
Return the specified output's type. See the [enum Variant.Type] values.
</description>
</method>
<method name="_get_text" qualifiers="virtual">
@ -136,17 +136,17 @@
The start mode used the first time when [method _step] is called.
</constant>
<constant name="START_MODE_CONTINUE_SEQUENCE" value="1" enum="StartMode">
The start mode used when [method _step] is called after coming back from a STEP_PUSH_STACK_BIT.
The start mode used when [method _step] is called after coming back from a [constant STEP_PUSH_STACK_BIT].
</constant>
<constant name="START_MODE_RESUME_YIELD" value="2" enum="StartMode">
The start mode used when [method _step] is called after resuming from STEP_YIELD_BIT.
The start mode used when [method _step] is called after resuming from [constant STEP_YIELD_BIT].
</constant>
<constant name="STEP_PUSH_STACK_BIT" value="16777216">
Hint used by [method _step] to tell that control should return to it when there is no other node left to execute.
This is used by [VisualScriptCondition] to redirect the sequence to the "Done" port after the [code]true[/code]/[code]false[/code] branch has finished execution.
</constant>
<constant name="STEP_GO_BACK_BIT" value="33554432">
Hint used by [method _step] to tell that control should return back, either hitting a previous STEP_PUSH_STACK_BIT or exiting the function.
Hint used by [method _step] to tell that control should return back, either hitting a previous [constant STEP_PUSH_STACK_BIT] or exiting the function.
</constant>
<constant name="STEP_NO_ADVANCE_BIT" value="67108864">
</constant>