summaryrefslogtreecommitdiff
path: root/doc/classes/VisualShaderNodeGroupBase.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/VisualShaderNodeGroupBase.xml')
-rw-r--r--doc/classes/VisualShaderNodeGroupBase.xml48
1 files changed, 24 insertions, 24 deletions
diff --git a/doc/classes/VisualShaderNodeGroupBase.xml b/doc/classes/VisualShaderNodeGroupBase.xml
index 1b724b00d6..dcc94f0b24 100644
--- a/doc/classes/VisualShaderNodeGroupBase.xml
+++ b/doc/classes/VisualShaderNodeGroupBase.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeGroupBase" inherits="VisualShaderNodeResizableBase" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
- Base class for a family of nodes with variable amount of input and output ports within the visual shader graph.
+ Base class for a family of nodes with variable number of input and output ports within the visual shader graph.
</brief_description>
<description>
Currently, has no direct usage, use the derived classes instead.
@@ -11,20 +11,20 @@
<methods>
<method name="add_input_port">
<return type="void" />
- <argument index="0" name="id" type="int" />
- <argument index="1" name="type" type="int" />
- <argument index="2" name="name" type="String" />
+ <param index="0" name="id" type="int" />
+ <param index="1" name="type" type="int" />
+ <param index="2" name="name" type="String" />
<description>
- Adds an input port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code].
+ Adds an input port with the specified [param type] (see [enum VisualShaderNode.PortType]) and [param name].
</description>
</method>
<method name="add_output_port">
<return type="void" />
- <argument index="0" name="id" type="int" />
- <argument index="1" name="type" type="int" />
- <argument index="2" name="name" type="String" />
+ <param index="0" name="id" type="int" />
+ <param index="1" name="type" type="int" />
+ <param index="2" name="name" type="String" />
<description>
- Adds an output port with the specified [code]type[/code] (see [enum VisualShaderNode.PortType]) and [code]name[/code].
+ Adds an output port with the specified [param type] (see [enum VisualShaderNode.PortType]) and [param name].
</description>
</method>
<method name="clear_input_ports">
@@ -77,81 +77,81 @@
</method>
<method name="has_input_port" qualifiers="const">
<return type="bool" />
- <argument index="0" name="id" type="int" />
+ <param index="0" name="id" type="int" />
<description>
Returns [code]true[/code] if the specified input port exists.
</description>
</method>
<method name="has_output_port" qualifiers="const">
<return type="bool" />
- <argument index="0" name="id" type="int" />
+ <param index="0" name="id" type="int" />
<description>
Returns [code]true[/code] if the specified output port exists.
</description>
</method>
<method name="is_valid_port_name" qualifiers="const">
<return type="bool" />
- <argument index="0" name="name" type="String" />
+ <param index="0" name="name" type="String" />
<description>
Returns [code]true[/code] if the specified port name does not override an existed port name and is valid within the shader.
</description>
</method>
<method name="remove_input_port">
<return type="void" />
- <argument index="0" name="id" type="int" />
+ <param index="0" name="id" type="int" />
<description>
Removes the specified input port.
</description>
</method>
<method name="remove_output_port">
<return type="void" />
- <argument index="0" name="id" type="int" />
+ <param index="0" name="id" type="int" />
<description>
Removes the specified output port.
</description>
</method>
<method name="set_input_port_name">
<return type="void" />
- <argument index="0" name="id" type="int" />
- <argument index="1" name="name" type="String" />
+ <param index="0" name="id" type="int" />
+ <param index="1" name="name" type="String" />
<description>
Renames the specified input port.
</description>
</method>
<method name="set_input_port_type">
<return type="void" />
- <argument index="0" name="id" type="int" />
- <argument index="1" name="type" type="int" />
+ <param index="0" name="id" type="int" />
+ <param index="1" name="type" type="int" />
<description>
Sets the specified input port's type (see [enum VisualShaderNode.PortType]).
</description>
</method>
<method name="set_inputs">
<return type="void" />
- <argument index="0" name="inputs" type="String" />
+ <param index="0" name="inputs" type="String" />
<description>
Defines all input ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_input_port]).
</description>
</method>
<method name="set_output_port_name">
<return type="void" />
- <argument index="0" name="id" type="int" />
- <argument index="1" name="name" type="String" />
+ <param index="0" name="id" type="int" />
+ <param index="1" name="name" type="String" />
<description>
Renames the specified output port.
</description>
</method>
<method name="set_output_port_type">
<return type="void" />
- <argument index="0" name="id" type="int" />
- <argument index="1" name="type" type="int" />
+ <param index="0" name="id" type="int" />
+ <param index="1" name="type" type="int" />
<description>
Sets the specified output port's type (see [enum VisualShaderNode.PortType]).
</description>
</method>
<method name="set_outputs">
<return type="void" />
- <argument index="0" name="outputs" type="String" />
+ <param index="0" name="outputs" type="String" />
<description>
Defines all output ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_output_port]).
</description>