summaryrefslogtreecommitdiffstats
path: root/doc/classes/Plane.xml
diff options
context:
space:
mode:
authorYuri Sizov <yuris@humnom.net>2023-10-02 20:11:43 +0200
committerYuri Sizov <yuris@humnom.net>2023-10-03 15:48:31 +0200
commitcc0eebd9d8a42f3e57d4633c4388faa6d369d2c8 (patch)
treee539714cf844f473b5417ee388f9eeab113a863c /doc/classes/Plane.xml
parenta2f90d565ad29edcb3bdab77bc7df51cdde8514a (diff)
downloadredot-engine-cc0eebd9d8a42f3e57d4633c4388faa6d369d2c8.tar.gz
Validate `code` tags for class and member references
This commit also adds means to manually disable warnings in `code` tags where it's a false positive with the new `skip-lint` attribute. Warnings are now enabled on CI to prevent future errors.
Diffstat (limited to 'doc/classes/Plane.xml')
-rw-r--r--doc/classes/Plane.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/Plane.xml b/doc/classes/Plane.xml
index 6faf83c0d6..a0da82d1d6 100644
--- a/doc/classes/Plane.xml
+++ b/doc/classes/Plane.xml
@@ -152,11 +152,11 @@
<members>
<member name="d" type="float" setter="" getter="" default="0.0">
The distance from the origin to the plane, expressed in terms of [member normal] (according to its direction and magnitude). Actual absolute distance from the origin to the plane can be calculated as [code]abs(d) / normal.length()[/code] (if [member normal] has zero length then this [Plane] does not represent a valid plane).
- In the scalar equation of the plane [code]ax + by + cz = d[/code], this is [code]d[/code], while the [code](a, b, c)[/code] coordinates are represented by the [member normal] property.
+ In the scalar equation of the plane [code]ax + by + cz = d[/code], this is [code skip-lint]d[/code], while the [code](a, b, c)[/code] coordinates are represented by the [member normal] property.
</member>
<member name="normal" type="Vector3" setter="" getter="" default="Vector3(0, 0, 0)">
The normal of the plane, typically a unit vector. Shouldn't be a zero vector as [Plane] with such [member normal] does not represent a valid plane.
- In the scalar equation of the plane [code]ax + by + cz = d[/code], this is the vector [code](a, b, c)[/code], where [code]d[/code] is the [member d] property.
+ In the scalar equation of the plane [code]ax + by + cz = d[/code], this is the vector [code](a, b, c)[/code], where [code skip-lint]d[/code] is the [member d] property.
</member>
<member name="x" type="float" setter="" getter="" default="0.0">
The X component of the plane's [member normal] vector.