b118d89eed
Overhaul the top sections of the class reference (Core classes)
...
(cherry picked from commit 04562662d3
2023-06-16 15:12:10 +02:00
32dc3b66ab
Remove double thes from documentation
...
(cherry picked from commit 4431cdd154
2023-04-24 17:08:56 +02:00
a5572ba5a3
C# Truncate instead of round in Vector2/3/4 to Vector2I/3I/4I conversion
...
(cherry picked from commit f53d3382af
2023-04-07 17:44:36 +02:00
4a8b725bc9
Merge pull request #68386 from MewPurPur/snappedi-snappedf
...
Implement snappedi, snappedf, and Vector[2/3/4]i.snapped
2022-11-24 18:54:49 +01:00
e26f0906f2
Implement snappedi, snappedf, and Vector[2/3/4]i.snapped
2022-11-19 06:18:55 +01:00
edfb504efe
Document that Vector classes are 32-bit
2022-11-12 15:51:11 -05:00
5361585832
[doc] Use "param" instead of "code" to refer to parameters
...
Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2022-08-09 10:09:07 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03: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
8c7268664d
Fix integer vector mul/div operators and bindings.
...
* Vector2i and Vector3i mul/div by a float results in Vector2 and Vector3 respectively.
* Create specializations to allow proper bindings.
This fixes #44408 and supersedes #44441 and keeps the same rule of int <op> float returnig float, like with scalars.
2022-02-06 13:34:41 +01:00
2c52f16464
Add length and length_squared to Vector2i/3i
2022-01-06 10:06:56 -08:00
3d08becd06
Unify similar method descriptions
...
Notably:
* `Packed*Array.size()` and `Array.size()`.
* Shared methods of `Transform2D` and `Transform3D`.
* Shared methods of `Vector2`, `Vector3`, and `Vector2i`.
This reduces the Deja Vu when translating the class reference :)
2022-01-06 19:50:57 +08:00
24f57886d0
Expose max_axis_index and max_axis_index for Vector2(i)
...
Some cleanup with Vector3(i)'s methods so that it is consistent with Vector2, for example it returns enums internally (GDScript still gets ints).
2021-12-02 23:45:41 -06: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
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
455e142d37
Allow comparing equality between builtin types and null
2021-09-17 12:33:52 -03: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
b1d15c51bc
Implement native extension system
...
* Deprecates GDNative in favor of a simpler, lower level interface.
* New extension system allows registering core engine classes.
* Simple header interface in gdnative_interace.h
2021-06-25 17:32:45 -03:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
2e13e3ed4a
Allow clamping vectors and colors
2021-06-03 12:05:20 -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
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
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
227f12478d
Document how Vector2, Vector3 and Color behave in a boolean context
...
See #39731 .
2020-06-21 17:16:10 +02:00
d7cf1b5c73
Fix docs generation for Vector2i/Vector3i/Rect2i
2020-06-03 15:22:26 +03:00
6c8f2ae53a
Update docs and bindings for new integer vector types
2020-02-25 15:27:29 +01:00
VolTer
Paweł
kleonc
Rémi Verschelde
Jonathan Nicholl
Andy Maloney
Yuri Sizov
Yuri Roubinsky
Hugo Locurcio
reduz
Aaron Franke
Haoyu Qiu
Rémi Verschelde
George Marques
Michael Alexsander Silva Dias