godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #38178 from akien-mga/doc-typed-arrays

Browse Source 
doc: Fix parsing typed arrays in makerst.py
This commit is contained in:
Rémi Verschelde 2020-04-25 00:08:40 +02:00 committed by GitHub
commit 77843bde77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 51 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/classes/@GlobalScope.xml
View File

@ -21,6 +21,9 @@
<member name="ClassDB" type="ClassDB" setter="" getter="">
The [ClassDB] singleton.
</member>
<member name="DisplayServer" type="DisplayServer" setter="" getter="">
The [DisplayServer] singleton.
</member>
<member name="Engine" type="Engine" setter="" getter="">
The [Engine] singleton.
</member>

4
doc/classes/Area2D.xml
View File

@ -29,14 +29,14 @@
</description>
</method>
<method name="get_overlapping_areas" qualifiers="const">
<return type="Array">
<return type="Area2D[]">
</return>
<description>
Returns a list of intersecting [Area2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
</description>
</method>
<method name="get_overlapping_bodies" qualifiers="const">
<return type="Array">
<return type="Node2D[]">
</return>
<description>
Returns a list of intersecting [PhysicsBody2D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

4
doc/classes/Area3D.xml
View File

@ -28,14 +28,14 @@
</description>
</method>
<method name="get_overlapping_areas" qualifiers="const">
<return type="Array">
<return type="Area3D[]">
</return>
<description>
Returns a list of intersecting [Area3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
</description>
</method>
<method name="get_overlapping_bodies" qualifiers="const">
<return type="Array">
<return type="Node3D[]">
</return>
<description>
Returns a list of intersecting [PhysicsBody3D]s. For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.

2
doc/classes/EditorSelection.xml
View File

@ -27,7 +27,7 @@
</description>
</method>
<method name="get_selected_nodes">
<return type="Array">
<return type="Node[]">
</return>
<description>
Gets the list of selected nodes.

2
doc/classes/Node.xml
View File

@ -221,7 +221,7 @@
</description>
</method>
<method name="get_children" qualifiers="const">
<return type="Array">
<return type="Node[]">
</return>
<description>
Returns an array of references to node's children.

2
doc/classes/PhysicsBody2D.xml
View File

@ -20,7 +20,7 @@
</description>
</method>
<method name="get_collision_exceptions">
<return type="Array">
<return type="PhysicsBody2D[]">
</return>
<description>
Returns an array of nodes that were added as collision exceptions for this body.

2
doc/classes/PhysicsBody3D.xml
View File

@ -20,7 +20,7 @@
</description>
</method>
<method name="get_collision_exceptions">
<return type="Array">
<return type="PhysicsBody3D[]">
</return>
<description>
Returns an array of nodes that were added as collision exceptions for this body.

12
doc/classes/ProjectSettings.xml
View File

@ -806,6 +806,18 @@
<member name="memory/limits/multithreaded_server/rid_pool_prealloc" type="int" setter="" getter="" default="60">
This is used by servers when used in multi-threading mode (servers and visual). RIDs are preallocated to avoid stalling the server requesting them on threads. If servers get stalled too often when loading resources in a thread, increase this number.
</member>
<member name="mono/debugger_agent/port" type="int" setter="" getter="" default="23685">
</member>
<member name="mono/debugger_agent/wait_for_debugger" type="bool" setter="" getter="" default="false">
</member>
<member name="mono/debugger_agent/wait_timeout" type="int" setter="" getter="" default="3000">
</member>
<member name="mono/profiler/args" type="String" setter="" getter="" default="&quot;log:calls,alloc,sample,output=output.mlpd&quot;">
</member>
<member name="mono/profiler/enabled" type="bool" setter="" getter="" default="false">
</member>
<member name="mono/unhandled_exception_policy" type="int" setter="" getter="" default="0">
</member>
<member name="network/limits/debugger/max_chars_per_second" type="int" setter="" getter="" default="32768">
Maximum amount of characters allowed to send as output from the debugger. Over this value, content is dropped. This helps not to stall the debugger connection.
</member>

34
doc/classes/RDPipelineColorBlendState.xml
View File

@ -7,40 +7,10 @@
<tutorials>
</tutorials>
<methods>
<method name="add_attachment">
<return type="void">
</return>
<argument index="0" name="atachment" type="RDPipelineColorBlendStateAttachment">
</argument>
<description>
</description>
</method>
<method name="add_blend_mix_attachment">
<return type="void">
</return>
<description>
</description>
</method>
<method name="add_no_blend_attachment">
<return type="void">
</return>
<description>
</description>
</method>
<method name="clear_attachments">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_attachments" qualifiers="const">
<return type="Array">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="attachments" type="RDPipelineColorBlendStateAttachment[]" setter="set_attachments" getter="get_attachments" default="[ ]">
</member>
<member name="blend_constant" type="Color" setter="set_blend_constant" getter="get_blend_constant" default="Color( 0, 0, 0, 1 )">
</member>
<member name="enable_logic_op" type="bool" setter="set_enable_logic_op" getter="get_enable_logic_op" default="false">

6
doc/classes/RDPipelineColorBlendStateAttachment.xml
View File

@ -7,6 +7,12 @@
<tutorials>
</tutorials>
<methods>
<method name="set_as_mix">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="alpha_blend_op" type="int" setter="set_alpha_blend_op" getter="get_alpha_blend_op" enum="RenderingDevice.BlendOperation" default="0">

22
doc/classes/RDPipelineMultisampleState.xml
View File

@ -7,26 +7,6 @@
<tutorials>
</tutorials>
<methods>
<method name="add_sample_mask">
<return type="void">
</return>
<argument index="0" name="mask" type="int">
</argument>
<description>
</description>
</method>
<method name="clear_sample_masks">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_sample_masks" qualifiers="const">
<return type="PackedInt64Array">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="enable_alpha_to_coverage" type="bool" setter="set_enable_alpha_to_coverage" getter="get_enable_alpha_to_coverage" default="false">
@ -39,6 +19,8 @@
</member>
<member name="sample_count" type="int" setter="set_sample_count" getter="get_sample_count" enum="RenderingDevice.TextureSamples" default="0">
</member>
<member name="sample_masks" type="int[]" setter="set_sample_masks" getter="get_sample_masks" default="[ ]">
</member>
</members>
<constants>
</constants>

2
doc/classes/RDVertexDescription.xml → doc/classes/RDVertexAttribute.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="RDVertexDescription" inherits="Reference" version="4.0">
<class name="RDVertexAttribute" inherits="Reference" version="4.0">
<brief_description>
</brief_description>
<description>

10
doc/classes/RenderingDevice.xml
View File

@ -296,7 +296,7 @@
<method name="framebuffer_format_create">
<return type="int">
</return>
<argument index="0" name="attachments" type="Array">
<argument index="0" name="attachments" type="RDAttachmentFormat[]">
</argument>
<description>
</description>
@ -386,9 +386,9 @@
</argument>
<argument index="1" name="format" type="int" enum="RenderingDevice.IndexBufferFormat">
</argument>
<argument index="2" name="data" type="PackedByteArray">
<argument index="2" name="data" type="PackedByteArray" default="PackedByteArray( )">
</argument>
<argument index="3" name="arg3" type="bool" default="PackedByteArray( )">
<argument index="3" name="arg3" type="bool" default="false">
</argument>
<description>
</description>
@ -576,7 +576,7 @@
</argument>
<argument index="1" name="view" type="RDTextureView">
</argument>
<argument index="2" name="data" type="Array" default="[ ]">
<argument index="2" name="data" type="PackedByteArray[]" default="[ ]">
</argument>
<description>
</description>
@ -712,7 +712,7 @@
<method name="vertex_format_create">
<return type="int">
</return>
<argument index="0" name="vertex_descriptions" type="Array">
<argument index="0" name="vertex_descriptions" type="RDVertexAttribute[]">
</argument>
<description>
</description>

2
doc/classes/RigidBody2D.xml
View File

@ -81,7 +81,7 @@
</description>
</method>
<method name="get_colliding_bodies" qualifiers="const">
<return type="Array">
<return type="Node2D[]">
</return>
<description>
Returns a list of the bodies colliding with this one. Use [member contacts_reported] to set the maximum number reported. You must also set [member contact_monitor] to [code]true[/code].

2
doc/classes/Skeleton3D.xml
View File

@ -157,7 +157,7 @@
<method name="physical_bones_start_simulation">
<return type="void">
</return>
<argument index="0" name="bones" type="Array" default="[ ]">
<argument index="0" name="bones" type="StringName[]" default="[ ]">
</argument>
<description>
</description>

4
doc/classes/TileMap.xml
View File

@ -74,14 +74,14 @@
</description>
</method>
<method name="get_used_cells" qualifiers="const">
<return type="Array">
<return type="Vector2i[]">
</return>
<description>
Returns a [Vector2] array with the positions of all cells containing a tile from the tileset (i.e. a tile index different from [code]-1[/code]).
</description>
</method>
<method name="get_used_cells_by_id" qualifiers="const">
<return type="Array">
<return type="Vector2i[]">
</return>
<argument index="0" name="id" type="int">
</argument>

13
doc/tools/makerst.py
View File

@ -973,11 +973,14 @@ def format_table(f, data, remove_empty_columns=False): # type: (TextIO, Iterabl
f.write("\n")
def make_type(t, state): # type: (str, State) -> str
if t in state.classes:
return ":ref:`{0}<class_{0}>`".format(t)
print_error("Unresolved type '{}', file: {}".format(t, state.current_class), state)
return t
def make_type(klass, state): # type: (str, State) -> str
link_type = klass
if link_type.endswith("[]"): # Typed array, strip [] to link to contained type.
link_type = link_type[:-2]
if link_type in state.classes:
return ":ref:`{}<class_{}>`".format(klass, link_type)
print_error("Unresolved type '{}', file: {}".format(klass, state.current_class), state)
return klass
def make_enum(t, state): # type: (str, State) -> str