Sara/behaviour-tree-test
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

Proofread and improve the whole class reference

Browse source 
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
This commit is contained in:
Hugo Locurcio 2019-06-22 01:04:47 +02:00
parent 538c8eec15
commit f7f6115f76
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
330 changed files with 2585 additions and 2474 deletions
Download patch file Download diff file Expand all files Collapse all files

16
doc/classes/Plane.xml
View file

@ -22,7 +22,7 @@
<argument index="3" name="d" type="float">
</argument>
<description>
Creates a plane from the four parameters "a", "b", "c" and "d".
Creates a plane from the four parameters [code]a[/code], [code]b[/code], [code]c[/code] and [code]d[/code].
</description>
</method>
<method name="Plane">
@ -62,7 +62,7 @@
<argument index="0" name="point" type="Vector3">
</argument>
<description>
Returns the shortest distance from the plane to the position "point".
Returns the shortest distance from the plane to the position [code]point[/code].
</description>
</method>
<method name="get_any_point">
@ -80,7 +80,7 @@
<argument index="1" name="epsilon" type="float" default="0.00001">
</argument>
<description>
Returns [code]true[/code] if "point" is inside the plane (by a very minimum threshold).
Returns [code]true[/code] if [code]point[/code] is inside the plane (by a very minimum [code]epsilon[/code] threshold).
</description>
</method>
<method name="intersect_3">
@ -91,7 +91,7 @@
<argument index="1" name="c" type="Plane">
</argument>
<description>
Returns the intersection point of the three planes "b", "c" and this plane. If no intersection is found null is returned.
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">
@ -102,7 +102,7 @@
<argument index="1" name="dir" type="Vector3">
</argument>
<description>
Returns the intersection point of a ray consisting of the position "from" and the direction normal "dir" with this plane. If no intersection is found null is returned.
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">
@ -113,7 +113,7 @@
<argument index="1" name="end" type="Vector3">
</argument>
<description>
Returns the intersection point of a segment from position "begin" to position "end" with this plane. If no intersection is found null is returned.
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_point_over">
@ -122,7 +122,7 @@
<argument index="0" name="point" type="Vector3">
</argument>
<description>
Returns [code]true[/code] if "point" is located above the plane.
Returns [code]true[/code] if [code]point[/code] is located above the plane.
</description>
</method>
<method name="normalized">
@ -138,7 +138,7 @@
<argument index="0" name="point" type="Vector3">
</argument>
<description>
Returns the orthogonal projection of point "p" into a point in the plane.
Returns the orthogonal projection of point [code]p[/code] into a point in the plane.
</description>
</method>
</methods>