d32803fdd6
[doc] Use "param" instead of "code" to refer to parameters (7)
2022-08-12 13:19:48 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
e7a58a7eb6
Core: Rename math 'phi' arguments to 'angle'
2022-05-05 14:17:39 +02:00
32f2c47356
Remove generating of null comparison operators from documentation
2022-03-14 22:35:23 +03:00
b68dd2e189
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-02-15 00:03:31 +01:00
471e7cbfc7
Merge pull request #54581 from aaronfranke/operator-docs
2021-11-16 14:10:09 +01:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
813466b3c8
Add documentation to operators for math types
...
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2021-11-04 14:44:55 -05:00
6772ebcea0
Move the docs for constructors and operators out of methods section
2021-10-29 12:34:57 -05:00
d03b7fbe09
Refactored Node3D rotation modes
...
* Made the Basis euler orders indexed via enum.
* Node3D has a new rotation_order property to choose Euler rotation order.
* Node3D has also a rotation_mode property to choose between Euler, Quaternion and Basis
Exposing these modes as well as the order makes Godot a lot friendlier for animators, which can choose the best way to interpolate rotations.
The new *Basis* mode makes the (exposed) transform property obsolete, so it was removed (can still be accessed by code of course).
2021-10-25 14:34:00 -03:00
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
220b69ab56
Merge pull request #52450 from aaronfranke/they-came-from-scale
...
Replace Vector3.to_diagonal_matrix with Basis.from_scale
2021-09-17 19:38:36 +02:00
455e142d37
Allow comparing equality between builtin types and null
2021-09-17 12:33:52 -03:00
bf0213470c
Replace Vector3.to_diagonal_matrix with Basis.from_scale
2021-09-17 10:30:30 -05:00
9f3ae0adcd
Move code for looking_at to Basis
2021-08-01 12:49:02 -05:00
7adf4cc9b5
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.
2021-07-30 15:29:52 +02:00
3fc39954ec
Merge pull request #49638 from aaronfranke/multiply-transforms
...
Allow multiplying Transforms and Basis by numbers
2021-06-18 12:35:14 +02:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
bd6ed3fb09
Allow multiplying Transforms and Basis by numbers
2021-06-15 22:26:29 -04:00
8acd13a456
Rename Quat to Quaternion
2021-06-04 18:14:32 +01:00
0ac4051c00
Update documentation for Transform3D
2021-06-03 07:30:01 -04:00
4ca1e73ff9
doc: Sync classref with current source
...
And move GLTF docs to its module folder.
2021-03-18 16:37:43 +01:00
5465e604bb
Improve argument names for core types
2020-12-07 05:01:33 -05:00
64e893deac
doc: Sync classref to add operators after #43419
2020-11-10 15:00:50 +01:00
0f249f5c0a
Variant: Sync docs with new constructors, fixups after #43403
...
Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
2020-11-09 23:39:53 +01:00
424cd00f8b
doc: Sync classref with current source + fixup some bindings
...
Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
a33fe75050
doc: Sync classref with current source
2020-10-09 15:04:15 +02:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
83e324d670
Update core documentation to match recent C# changes
...
Also a few minor API changes like adding AABB.abs()
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2020-07-21 14:44:53 -04:00
788765709d
DocData: Fix serialization of Variant default values
...
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2020-03-09 10:52:44 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
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
bb62c07fce
Improve the Basis class documentation
2019-12-22 18:04:51 +01:00
3231fca934
Add docs for is_equal_approx on structures
2019-11-30 16:52:27 -05:00
592909db16
doc: Sync classref with current source
2019-08-13 12:35:50 +02:00
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
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
426bcc9941
Change "Return" to "Returns" where necessary in XML documentation
...
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".
Fixes #28867
2019-05-23 21:11:24 -07:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
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
ed7aadcd87
Add SLERP to Vector{2,3}, optimize Quat's Vector3 rotation.
...
Also even out Basis and Quat APIs a little.
2018-05-12 13:05:04 -04:00
e83af5dfc6
Add new transform tutorial to appropriate classes
2018-04-09 17:44:13 +07:00
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
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
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
Andy Maloney
Yuri Sizov
Rémi Verschelde
Yuri Roubinsky
Hugo Locurcio
Rémi Verschelde
Aaron Franke
reduz
George Marques
Michael Alexsander Silva Dias
Marcel Admiraal
clayjohn
Sean Heffernan
robojumper
tagcup
Poommetee Ketson