Commit graph

33 commits

Author SHA1 Message Date
Haoyu Qiu
9315583af3 Fix mismatched parentheses in class reference 2024-05-30 15:54:53 +08:00
Emanuel Acosta Gonzalez (emanvidmaker)
40651eb642
FileAccess.xml had conflicting function names in its example code
In the example code the declared load() function conflicts with global scope load(). so if you copy pasted it in godot 4.2.2 you would get a "Too few arguments for "load()" call. Expected at least 1 but received 0." error since it doesn't override global scope load().
2024-04-25 18:51:37 -04:00
Rémi Verschelde
504d01b61e
Merge pull request #90403 from bruvzg/file_resize
[FileAccess] Implement `resize` method.
2024-04-22 12:51:55 +02:00
A Thousand Ships
b804193f08
[Doc] Clarify behavior of FileAccess.get_line
Specifies that the line excludes any newline or carriage return
characters.
2024-04-16 19:22:40 +02:00
bruvzg
88b3e68f93
[FileAccess] Implement resize method. 2024-04-12 19:20:49 +03:00
Micky
328b00774b Use [codeblock lang=text] more often in class ref 2024-04-08 16:17:50 +02:00
skyace65
c83718624f Update links to outdated asset library demos
Update links to outdated asset library demos

Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com>
2024-04-07 16:59:43 +02:00
A Thousand Ships
24c9d442e9
[Doc] Fix some incorrect uses of a/an 2024-03-13 21:20:28 +01:00
A Thousand Ships
a775d8bf5a
Clarify behavior of opening a new file in FileAccess
The containing directory must exist for this to succeed.
2024-03-05 19:34:19 +01:00
Hugo Locurcio
e5270c0db2
Link to runtime loading/saving tutorial and improve Image documentation 2023-11-14 12:05:54 +01:00
Paul Joannon
bf3f6e3b55
Error handling for FileAccess.get_file_as_*
- Assign last error in said `FileAccess.get_file_as_bytes` and `FileAccess.get_file_as_string`
- Document error handling for said methods
2023-10-11 18:52:16 +02:00
Yuri Sizov
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
Haoyu Qiu
d026b37abd Fix various typos in classref 2023-08-22 18:05:50 +08:00
bruvzg
8aa6f29b56
[FileAccess] Add methods to get/set "hidden" and "read-only" attributes on macOS/BSD and Windows. 2023-08-08 21:51:32 +03:00
Rémi Verschelde
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
Rémi Verschelde
346f1ab86b
Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
Max Hilbrunner
aaf43a260e Docs: Add FileAccess.close, remove dupl. example 2023-05-31 16:28:21 +02:00
VolTer
04562662d3 Overhaul the top sections of the class reference (Core classes) 2023-05-19 07:04:48 +02:00
Ninni Pipping
6bccdec7a1 Make documentation sorting use natural order 2023-05-09 17:47:52 +02:00
Yuri Sizov
391eccca76 Validate code tags in documentation for potential params
Adds a check to make_rst to look for matches
between the text inside of the [code][/code] tag
and known param identifiers.
Fixes most of what was revealed.
2023-04-26 21:36:04 +02:00
bruvzg
0e4bd964cc
Expose brotli decompression to the scripting API. 2023-03-29 22:43:36 +03:00
Rémi Verschelde
1c1524a651
Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
Haoyu Qiu
0c92c92891 Various classref typo fixes 2023-02-20 14:47:37 +08:00
bruvzg
bc95b0b171
Restore FileAccess.close method. 2023-02-16 15:34:20 +02:00
Yuri Sizov
5ca1123021
Merge pull request #71572 from RedMser/docs-binary-variant
Document internal usage of `encode`/`decode_variant`
2023-02-10 20:04:16 +03:00
Raul Santos
7eb8325180
Fix C# examples in documentation
- Fix documentation after C# renames.
- Add missing `partial` in C# class declarations.
- Change `delta` parameter type to `double` in C#.
- Ensure parameters match base declaration.
- Use `$` string interpolation in C#.
- Fix invalid or outdated C# code.
- Changed some examples to follow our style guide more closely.
2023-01-31 19:04:07 +01:00
RedMser
dc70ab5e2d Document internal usage of encode/decode_variant 2023-01-17 18:42:26 +01:00
bruvzg
ecec415988
Use system fonts as fallback and improve system font handling.
Add support for font weight and stretch selection when using system fonts.
Add function to get system fallback font from a font name, style, text, and language code.
Implement system font support for Android.
Use system fonts as a last resort fallback.
2022-12-04 18:44:20 +02:00
Emi
d196a07ea4 Replacing File calls from the FileAccess class docs
Co-Authored-By: bruvzg <7645683+bruvzg@users.noreply.github.com>
2022-10-03 13:04:40 +02:00
Rémi Verschelde
166df0896c Fix typos with codespell
Using codespell 2.3-dev from current git.

And fix typo in `methods.py` for `vsproj=yes` option (still won't work
though).
2022-09-30 14:23:36 +02:00
kobewi
cad1d27a6f Introduce more static methods to directory API 2022-09-20 14:22:45 +02:00
Raul Santos
95393c310d
Improve C# documentation for FileAccess and DirAccess
- Adds using statements to C# examples to ensure the resources are freed after usage
- Adds explanation about the importance of disposing the FileAccess now that we don't have a close method
2022-09-19 18:46:44 +02:00
kobewi
9f2dc68279 Replace File/Directory with FileAccess/DirAccess 2022-09-19 11:03:31 +02:00
Renamed from doc/classes/File.xml (Browse further)