c54e09a5a3
Overhaul some "uncommon" wording in class reference
2024-03-01 15:32:38 +01:00
4850b866e8
Clarify `PackedByteArray.decompress*` limitations with external data
2024-01-07 13:34:39 +01:00
80b636069a
Add performance note to Array.resize()
2023-11-10 00:41:39 +02:00
cc0eebd9d8
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.
2023-10-03 15:48:31 +02:00
7e3e13fc66
Doc: Reference String <-> PackedByteArray conversions from each other
2023-09-12 03:43:01 -05:00
2857b91385
Fix many typos in documentation
2023-07-19 19:56:06 +07:00
81064cc239
Doctool: Remove version attribute from XML header
...
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
346f1ab86b
Bump version to 4.2-dev
...
Keep on waitin'
2023-07-05 22:07:03 +02:00
6bccdec7a1
Make documentation sorting use natural order
2023-05-09 17:47:52 +02:00
0e4bd964cc
Expose brotli decompression to the scripting API.
2023-03-29 22:43:36 +03:00
d72b563250
Add GDScript `to_wchar_buffer` and `get_string_from_wchar` functions.
2023-03-21 15:39:54 +02:00
1c1524a651
Bump version to 4.1-dev
...
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
0c92c92891
Various classref typo fixes
2023-02-20 14:47:37 +08:00
9f2dc68279
Replace File/Directory with FileAccess/DirAccess
2022-09-19 11:03:31 +02:00
b099a8570c
Complete documentation of packed arrays
2022-08-19 00:43:29 +02:00
1df86ecea5
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 13:52:19 -04:00
9c4ad8191b
Expose clear method for packed arrays
2022-08-10 17:12:20 +08:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
33fd7c63e1
Prevent out-of-bounds write in array conversion; avoid logspam on empty arrays.
2022-06-30 18:04:33 -07:00
380a53f02f
Add search methods for packed arrays
...
* count()
* find()
* rfind()
2022-05-07 20:16:11 +08:00
24febff2dc
Remove Array link in description of PackedArrays
2022-04-23 11:06:02 +08: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
c6cefb1b79
`Array`: Relax `slice` bound checks to properly handle negative indices
...
The same is done for `Vector` (and thus `Packed*Array`).
`begin` and `end` can now take any value and will be clamped to
`[-size(), size()]`. Negative values are a shorthand for indexing the array
from the last element upward.
`end` is given a default `INT_MAX` value (which will be clamped to `size()`)
so that the `end` parameter can be omitted to go from `begin` to the max size
of the array.
This makes `slice` works similarly to numpy's and JavaScript's.
2022-01-10 22:42:03 +01: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
dd30253cdc
PackedByteArray, Array slice end exclusive, rename subarray to slice
2021-11-26 22:13:12 -06:00
e078f970db
Rename `remove()` to `remove_at()` when removing by index
2021-11-23 18:58:57 -07:00
6772ebcea0
Move the docs for constructors and operators out of methods section
2021-10-29 12:34:57 -05:00
b32f84d473
Merge pull request #52850 from mashumafi/vector-bsearch
2021-10-01 07:52:51 +02:00
214bbfbefe
Implement bsearch for Vector and Packed*Array
2021-09-30 23:57:26 +00:00
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05:00
455e142d37
Allow comparing equality between builtin types and null
2021-09-17 12:33:52 -03:00
f5d9c7b487
Replace stb_vorbis with libogg+libvorbis
2021-09-09 19:39:04 -07: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
20818c12b7
New to_***_array method to decode PackedByteArray to Packed***Array
...
Documentation for new PackedByteArray::to_***_array methods
Documentation for to_byte_array method for PackedInt32/Int64/Float32/Float64Array
2021-07-24 21:06:47 +02:00
efd27a63c1
Add fill method to Arrays and PackedArrays
2021-04-21 11:33:53 -03:00
29775a1714
doc: Sync classref with current source
2021-04-19 12:26:37 +02:00
c526a1e22d
Fix misformatted documentation from #47435 , #42827 , #46991
2021-04-04 23:25:40 +03:00
755c70b871
Rename Array.invert() to Array.reverse()
...
Does the same internally for List and Vector<>, which includes all
PackedArray types.
2021-03-21 10:20:08 +00:00
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
4ca1e73ff9
doc: Sync classref with current source
...
And move GLTF docs to its module folder.
2021-03-18 16:37:43 +01:00
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
5b937d493f
Rename empty() to is_empty()
2020-12-28 10:39:56 +00:00
2d56e09276
packed*arrays are pass by ref now. support duplicate and update documentation
2020-12-17 16:09:32 -06:00
91dd6da2ff
Merge pull request #43246 from HaSa1002/docs-lang-5
...
Docs: Port code examples to C# (M, N, O, P, Q, R)
2020-11-16 09:16:18 +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
a3df26e554
Docs: Port Code Examples to C# (M, N, O, P, R)
...
Includes:
* MarginContainer
* NavigationPolygon
* Node
* NodePath
* OS
* PackedByteArray
* PackedScene
* PacketPeerUDP
* PCKPacker
* Performance
* PhysicsShapeQueryParameters2D
* PhysicsShapeQueryParameters3D
* PrimitiveMesh
* ProjectSettings
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-09 10:05: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
3e78963bb9
Fix typos with codespell
...
Using codespell 1.17.1.
Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
fave
findn
leapyear
lod
merchantibility
nd
numer
ois
ony
que
seeked
synching
te
uint
unselect
webp
EOF
$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```
2020-09-18 13:44:25 +02:00
Micky
A Thousand Ships
MewPurPur
Yuri Sizov
Aaron Franke
Septian
Rémi Verschelde
Ninni Pipping
bruvzg
Haoyu Qiu
kobewi
Andy Maloney
Lyuma
Yuri Roubinsky
Hugo Locurcio
Nathan Franke
Lightning_A
Rémi Verschelde
mashumafi
George Marques
Ellen Poe
ChristopheClaustre
Matheus Lima Cunha
Marcel Admiraal
Paul Joannon
Jordan Schidlowsky
HaSa1002