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

doc: Use self-closing tags for return and argument

Browse Source 
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
doc/classes/Plane.xml
View File

@ -11,189 +11,143 @@
</tutorials>
<methods>
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<return type="Plane" />
<description>
Constructs a default-initialized [Plane] with all components set to [code]0[/code].
</description>
</method>
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="from" type="Plane">
</argument>
<return type="Plane" />
<argument index="0" name="from" type="Plane" />
<description>
Constructs a [Plane] as a copy of the given [Plane].
</description>
</method>
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="a" type="float">
</argument>
<argument index="1" name="b" type="float">
</argument>
<argument index="2" name="c" type="float">
</argument>
<argument index="3" name="d" type="float">
</argument>
<return type="Plane" />
<argument index="0" name="a" type="float" />
<argument index="1" name="b" type="float" />
<argument index="2" name="c" type="float" />
<argument index="3" name="d" type="float" />
<description>
Creates a plane from the four parameters. The three components of the resulting plane's [member normal] are [code]a[/code], [code]b[/code] and [code]c[/code], and the plane has a distance of [code]d[/code] from the origin.
</description>
</method>
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="normal" type="Vector3">
</argument>
<argument index="1" name="d" type="float">
</argument>
<return type="Plane" />
<argument index="0" name="normal" type="Vector3" />
<argument index="1" name="d" type="float" />
<description>
Creates a plane from the normal and the plane's distance to the origin.
</description>
</method>
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="point" type="Vector3">
</argument>
<argument index="1" name="normal" type="Vector3">
</argument>
<return type="Plane" />
<argument index="0" name="point" type="Vector3" />
<argument index="1" name="normal" type="Vector3" />
<description>
Creates a plane from the given position and a plane normal.
</description>
</method>
<method name="Plane" qualifiers="constructor">
<return type="Plane">
</return>
<argument index="0" name="point1" type="Vector3">
</argument>
<argument index="1" name="point2" type="Vector3">
</argument>
<argument index="2" name="point3" type="Vector3">
</argument>
<return type="Plane" />
<argument index="0" name="point1" type="Vector3" />
<argument index="1" name="point2" type="Vector3" />
<argument index="2" name="point3" type="Vector3" />
<description>
Creates a plane from the three points, given in clockwise order.
</description>
</method>
<method name="center" qualifiers="const">
<return type="Vector3">
</return>
<return type="Vector3" />
<description>
Returns the center of the plane.
</description>
</method>
<method name="distance_to" qualifiers="const">
<return type="float">
</return>
<argument index="0" name="point" type="Vector3">
</argument>
<return type="float" />
<argument index="0" name="point" type="Vector3" />
<description>
Returns the shortest distance from the plane to the position [code]point[/code].
</description>
</method>
<method name="has_point" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="point" type="Vector3">
</argument>
<argument index="1" name="epsilon" type="float" default="1e-05">
</argument>
<return type="bool" />
<argument index="0" name="point" type="Vector3" />
<argument index="1" name="epsilon" type="float" default="1e-05" />
<description>
Returns [code]true[/code] if [code]point[/code] is inside the plane. Comparison uses a custom minimum [code]epsilon[/code] threshold.
</description>
</method>
<method name="intersect_3" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="b" type="Plane">
</argument>
<argument index="1" name="c" type="Plane">
</argument>
<return type="Variant" />
<argument index="0" name="b" type="Plane" />
<argument index="1" name="c" type="Plane" />
<description>
Returns the intersection point of the three planes [code]b[/code], [code]c[/code] and this plane. If no intersection is found, [code]null[/code] is returned.
</description>
</method>
<method name="intersects_ray" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
<argument index="1" name="dir" type="Vector3">
</argument>
<return type="Variant" />
<argument index="0" name="from" type="Vector3" />
<argument index="1" name="dir" type="Vector3" />
<description>
Returns the intersection point of a ray consisting of the position [code]from[/code] and the direction normal [code]dir[/code] with this plane. If no intersection is found, [code]null[/code] is returned.
</description>
</method>
<method name="intersects_segment" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="from" type="Vector3">
</argument>
<argument index="1" name="to" type="Vector3">
</argument>
<return type="Variant" />
<argument index="0" name="from" type="Vector3" />
<argument index="1" name="to" type="Vector3" />
<description>
Returns the intersection point of a segment from position [code]begin[/code] to position [code]end[/code] with this plane. If no intersection is found, [code]null[/code] is returned.
</description>
</method>
<method name="is_equal_approx" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="to_plane" type="Plane">
</argument>
<return type="bool" />
<argument index="0" name="to_plane" type="Plane" />
<description>
Returns [code]true[/code] if this plane and [code]plane[/code] are approximately equal, by running [method @GlobalScope.is_equal_approx] on each component.
</description>
</method>
<method name="is_point_over" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="plane" type="Vector3">
</argument>
<return type="bool" />
<argument index="0" name="plane" type="Vector3" />
<description>
Returns [code]true[/code] if [code]point[/code] is located above the plane.
</description>
</method>
<method name="normalized" qualifiers="const">
<return type="Plane">
</return>
<return type="Plane" />
<description>
Returns a copy of the plane, normalized.
</description>
</method>
<method name="operator !=" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Plane">
</argument>
<return type="bool" />
<argument index="0" name="right" type="Plane" />
<description>
</description>
</method>
<method name="operator ==" qualifiers="operator">
<return type="bool">
</return>
<argument index="0" name="right" type="Plane">
</argument>
<return type="bool" />
<argument index="0" name="right" type="Plane" />
<description>
</description>
</method>
<method name="operator unary+" qualifiers="operator">
<return type="Plane">
</return>
<return type="Plane" />
<description>
</description>
</method>
<method name="operator unary-" qualifiers="operator">
<return type="Plane">
</return>
<return type="Plane" />
<description>
</description>
</method>
<method name="project" qualifiers="const">
<return type="Vector3">
</return>
<argument index="0" name="point" type="Vector3">
</argument>
<return type="Vector3" />
<argument index="0" name="point" type="Vector3" />
<description>
Returns the orthogonal projection of [code]point[/code] into a point in the plane.
</description>