Hugo Locurcio
b087538119
Add an XML schema for documentation
...
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.
Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00
Haoyu Qiu
fe1e6eb995
Explain what 2D cross product means
...
(cherry picked from commit d54586a8e6
2022-01-12 17:28:07 +01:00
Haoyu Qiu
df527b37d5
Unify similar method descriptions
...
Notably:
* `Pool*Array.size()` and `Array.size()`.
* Shared methods of `Transform2D` and `Transform`.
* Shared methods of `Vector2` and `Vector3`.
This reduces the Deja Vu when translating the class reference :)
2022-01-06 19:49:05 +08:00
Lertsenem
942f15fa4e
Fix error in Vector2.reflect() description
...
The description was probably copied from Vector3.reflect(), and
unfortunately did not match the 2D behaviour (where n is apparently the
direction vector of the symmetry line, not the normal).
(cherry picked from commit e1bf428cdc
2022-01-06 00:23:59 +01:00
Aaron Franke
1d8cef8236
[3.x] Backport some APIs in math structs
2021-11-27 01:19:45 -06:00
Rémi Verschelde
3ac2999f22
Replace Godot docs URL with $DOCS_URL in XML class reference
2021-11-15 17:22:47 +01:00
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
mechPenSketch
68b8cf75ea
Add Graph Illustrations to Doc
...
(cherry picked from commit 9ea619c486
2021-09-21 20:33:11 +02:00
Rémi Verschelde
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02:00
Rémi Verschelde
f5836b40d4
doc: Use self-closing tags for return and argument
...
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.
(cherry picked from commit 7adf4cc9b5
2021-08-03 10:20:19 +02:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
kleonc
4d7f642fb3
Improve some argument names for core types
2021-04-23 15:34:24 +02:00
Rémi Verschelde
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
Aaron Franke
a320d28f53
[3.2] Fix documentation for Vector2/3.sign()
2021-03-07 15:34:57 -05:00
Yuri Roubinsky
bafbb238af
Added a note describing a code behind Vector2/3.direction_to
...
(cherry picked from commit fa0683ed30
2020-12-29 16:02:00 +01:00
Rémi Verschelde
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
Aaron Franke
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
2020-10-19 16:10:01 +02:00
Haoyu Qiu
9bf09a909b
Surrounds boolean false with code tag
...
(cherry picked from commit aa7ce12bee
2020-09-29 13:57:56 +02:00
Tomasz Chabora
5433b8470c
Improve Vector2.angle() description
...
(cherry picked from commit a09078e64b
2020-08-14 00:32:05 +02:00
Aaron Franke
3ab5183ffa
[3.2] Backport core documentation changes to 3.2
...
Also add AABB.abs()
2020-07-21 21:22:54 -04:00
Aaron Franke
3fd7c33f39
Fix incorrect documentation for Vector2.angle()
...
(cherry picked from commit 299c3ec1c1
2020-07-03 15:34:30 +02:00
Hugo Locurcio
9889641bae
Document how Vector2, Vector3 and Color behave in a boolean context
...
See #39731 .
(cherry picked from commit 227f12478d
2020-06-21 21:44:02 +02:00
Rémi Verschelde
2d20fc39aa
doc: Drop unused 'category' property from header
...
We already removed it from the online docs with #35132 .
Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.
We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
Aaron Franke
3231fca934
Add docs for is_equal_approx on structures
2019-11-30 16:52:27 -05:00
Rémi Verschelde
1f76229378
doc: Sync classref with current source
2019-11-08 08:33:48 +01:00
Rémi Verschelde
65d61d0360
doc: Sync classref with current source
2019-08-29 15:33:52 +02:00
Aaron Franke
092346d82b
Add Vector2/3 sign and posmod functions, misc additions
...
Also make the docs more consistent, add Axis enum to Vector2, add > and >=. and C# also gets % and an override for vector-vector mod.
2019-08-17 18:31:55 -04:00
Hugo Locurcio
cb3676726b
Mention 32-bit integer limit in the PoolIntArray documentation
2019-08-02 14:44:41 +02:00
Rémi Verschelde
c6cea6e9b3
doc: Add default values to all properties
...
Thanks to @bojidar-bg's impressive work in #29380 .
2019-06-30 13:58:07 +02:00
Hugo Locurcio
f7f6115f76
Proofread and improve the whole class reference
...
- 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
2019-06-27 22:30:19 +02:00
Rémi Verschelde
cfb9709c10
doc: Sync classref with current source
2019-06-01 12:34:29 +02:00
Giacom
c00427add3
Added move_toward functions for float, Vector2 and Vector3
2019-05-28 11:39:35 +01:00
Jiří Procházka
04b49264f2
Small documentation improvements
2019-05-01 11:11:09 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
7f3373d79f
Merge pull request #27452 from Chaosus/direction_to
...
Added method to retrieve a direction vector from one point to another
2019-04-08 12:00:54 +02:00
Chaosus
55f3bd97a2
Added direction_to method to vectors
2019-04-05 17:09:57 +03:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Rémi Verschelde
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
Rémi Verschelde
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
Ashafix
bbfa37a29c
Added section that coordinates can be accessed via indexes
2018-10-24 15:22:44 +01:00
Kelly Thomas
215db9ff71
add ONE constants to Vector2 and Vector3
2018-10-07 21:33:18 +08:00
LikeLakers2
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
Chris Bradfield
285234e8d9
[DOCS] Corrections and clarifications
2018-08-27 18:56:43 -07:00
Rémi Verschelde
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
Thomas Herzog
037f4638ab
add project method to Vector2/3
2018-08-16 12:52:38 +02:00
Hugo Locurcio
61fd3cd32a
Document Vector2.round() and Vector3.round()
2018-06-27 00:02:24 +02:00
letheed
d759d25aca
Fix Vector2 doc of floor, add ceil doc
2018-06-15 19:08:19 +02:00
robojumper
98b59cf2a3
Add support for tutorial links to makerst.py
...
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
Rémi Verschelde
4c5dd51eb9
Sync classref with current source
...
Also fix binding of Basis.slerp
2018-05-28 14:53:15 +02:00
