Aaron Franke
141783d90f
[3.x] Expose `determinant` in Transform2D, rename internal method
2023-04-22 13:47:47 -05:00
Rémi Verschelde
0a8d5d7098
Bump version to 3.6-beta
2022-08-05 18:51:38 +02:00
Aaron Franke
fca4af0e58
Document limitations of negative scales in 2D and 3D
...
(cherry picked from commit 3398fb77a9
)
2022-06-16 10:15:41 +02:00
Rémi Verschelde
9e37599f36
Core: Rename math 'phi' arguments to 'angle'
...
(cherry picked from commit e7a58a7eb6
)
2022-05-05 15:02:46 +02:00
Micky
15f9803d28
Specify return value of Transform3D.scaled() and more
...
Add more `[code]` (Transform3D)
Co-authored-by: kleonc <9283098+kleonc@users.noreply.github.com>
Add more `[code]` (Transform2D)
Co-authored-by: kleonc <9283098+kleonc@users.noreply.github.com>
(cherry picked from commit 87599054d2
)
2022-05-05 15:02:46 +02:00
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
Rémi Verschelde
6f1fcdee0d
Merge pull request #49662 from kleonc/transforms-xform_inv-docs
2021-12-02 12:54:44 +01: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
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
Kevin Sanders
88ad05c5dc
Grammar fix.
...
(cherry picked from commit 6db57b9da2
)
2021-08-03 09:33:25 +02:00
kleonc
c20d097636
Clarify Transform.xform_inv docs
2021-06-16 19:22:41 +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
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
Aaron Franke
3ab5183ffa
[3.2] Backport core documentation changes to 3.2
...
Also add AABB.abs()
2020-07-21 21:22:54 -04: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
1b8b380993
Document that translated does not behave like rotated or scaled
2019-12-15 12:31:08 -05: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
Andrii Doroshenko (Xrayez)
07cff56f48
Add transform methods for PoolVector*Array
...
Similarly to `Vector2` and `Rect2` transforms in 2D and Vector3, Plane,
and AABB in 3D. PoolVector2Array and PoolVector3Array were the only
missing Variant types in both Transform2D and Transform respectively.
2019-08-29 14:47:33 +03:00
Marco Costa
f99e84d180
Document constants in Transform/Transform2D
2019-07-04 23:51:51 -04: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
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Rémi Verschelde
f92b87e5f8
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:41:14 +02:00
Rémi Verschelde
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
Rémi Verschelde
3fa77b3172
doc: Remove status from hardcoded version string
...
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
Poommetee Ketson
ebe2337515
Fix wrong return type of xform functions
2018-01-30 18:45:54 +07:00
Rémi Verschelde
d516aab8fa
doc: Sync with current source
...
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Chris Bradfield
00c2005307
[DOCS] minor corrections to Transform2D
2017-12-24 13:12:07 -08:00
Rémi Verschelde
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
Rémi Verschelde
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
Rémi Verschelde
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
Andreas Haas
4c716f3623
[DOCS] Fix a few typos.
2017-10-14 12:45:49 +02:00
Rémi Verschelde
210ebb5cdb
doc: Sync classref with current source
...
[ci skip]
2017-09-23 10:59:41 +02:00
letheed
5ad9be4c24
Rename pos to position in user facing methods and variables
...
Rename user facing methods and variables as well as the corresponding
C++ methods according to the folloming changes:
* pos -> position
* rot -> rotation
* loc -> location
C++ variables are left as is.
2017-09-20 13:11:10 +02:00
Przemysław Gołąb (n-pigeon)
c32d857480
Spatial, Transform and Transform2D documentation tweaks
2017-09-15 09:16:30 +02:00
Rémi Verschelde
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +02:00
Juan Linietsky
4f929a0fdf
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
...
recognize them.
2017-09-12 17:45:41 -03:00