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
64934d755b
Merge pull request #54833 from KoBeWi/it's_a_trap
2021-12-03 10:10:23 +01:00
09b1fc1956
Improve store_string() description
2021-12-02 18:37:25 +01:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
e156b0cc19
Merge pull request #49041 from madmiraal/fix-docs-4085
...
Clarify that eof_reached() cannot be used to check if more data is available
2021-09-16 00:19:35 +02:00
ae1702bee5
Replace HTTP links with HTTPS for sites with HTTPS versions
2021-08-22 20:13:11 -05:00
b8c08ba5ad
Tests: Improve coverage for `File::get_csv_line()`
...
Adds a few more complex edge cases which are supported.
Also adds some documentation, simplifies the code a bit and forbids using
double quotes as a delimiter.
2021-08-04 11:53:21 +02: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
76dc811c76
Merge pull request #49470 from levilindsey/master
...
Update File.store_var description to mention which properties of an object are included.
2021-06-29 13:59:17 +02:00
2b7c0cfb34
Update File.store_var description to mention which properties of an object are included.
2021-06-15 20:00:19 -07:00
ac73059b56
Merge pull request #49123 from aaronfranke/it-is-time
...
Add a Time singleton
2021-06-12 22:55:25 +02:00
04688b92ff
Rename Reference to RefCounted
2021-06-11 18:48:42 +02:00
f64fea1b23
Add Time singleton
2021-06-11 09:32:39 -04:00
7ab34e1a96
Merge pull request #48889 from Calinou/file-rename-endian-swap
...
Rename File's `endian_swap` to `big_endian`
2021-06-03 15:19:07 +02:00
570d65cd98
Clarify that eof_reached() cannot be used to check if more data is available
2021-05-28 16:20:51 +01:00
da5d7db610
Rename File::get_len() get_length()
2021-05-25 11:54:28 +01:00
12462d9055
Rename File's `endian_swap` to `big_endian`
...
This new name is more consistent with ResourceSaver and StreamPeer.
2021-05-20 14:58:03 +02:00
5f098d6db6
Document that `File.open_compressed()` can only open files saved by Godot
2021-05-01 01:24:01 +02:00
ab397460e9
Expose a `File.flush()` method to scripting
...
This can be used to ensure a file has its contents saved
even if the project crashes or is killed by the user
(among other use cases).
See discussion in #29075 .
2021-02-13 01:37:16 +01:00
c5f0db45df
Improve the `File.endian_swap` documentation
2021-02-02 21:59:55 +01:00
5a01c2a3b0
Docs: Port Code Examples to C# (F, G, H, I, J, K, L)
...
Includes:
* File
* Geometry2D
* HashingContext
* HTTPClient
* HTTPRequest
* Image
* Input
* int
* ItemList
* JSONParseResult
* KinematicBody2D
* LineEdit
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-25 22:15:13 +01:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
2762821c08
Clarify store_string vs store_line.
...
While the behavior can be implied from the name, it seems worth stating
it explicitly.
2020-10-01 07:03:24 -04:00
75c5a8b354
Move note about using Resource in the File documentation
2020-09-24 10:37:03 -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
5e77eea216
Updated cursor positioning description for File open()
...
Added more details about the cursor offsets for the different ModeFlags
in the `File` class.
2020-08-04 13:53:52 +08:00
3f6a7c74e3
Added missing information about File.open_encrypted function to docs.
2020-07-31 12:57:44 +02:00
d4085d6bfb
Mention the Data paths documentation in the File class
...
This closes https://github.com/godotengine/godot-docs/issues/3799 .
2020-07-15 16:10:06 +02:00
cd25d184a5
doc: Make File store/get integer methods clearer
...
Add an example on how to store signed integers on less than 64 bits,
using one bit for the signedness.
2020-06-09 23:26:10 +02:00
97e20b2f30
Improve the `File.store_{8,16,32,64}()` documentation
...
Added information about the intervals of values that the functions
`store_{8,16,32,64}()` can correctly write to the file.
2020-03-25 18:02:04 +03:00
213a85521d
doc: Sync classref with current source
...
Handle removal of Pool*Array types and other recent changes.
2020-02-18 14:02:02 +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
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
528c4722d6
doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred
2019-06-27 14:43:37 +02:00
0764451dc5
doc: Improve docs for Resource* classes
...
Also move module-specific classes to their own module's `doc_classes`
folder.
2019-06-18 20:07:26 +02: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
d1c095b30a
Clarify encoding used for text by the File class
2019-04-06 12:39:58 +02:00
e3bd84fa57
Merge pull request #27485 from Faless/io/encode_decode_safety_pr
...
Safer encode/decode variant.
2019-04-01 17:00:40 +02:00
393e62b98a
Add object encoding param to serialization methods
...
Network peers get_var/put_var
File get_var/store_var
GDScript/Mono/VisualScript bytes2var/var2bytes
Add MultiplayerAPI.allow_object_decoding member which deprecates PacketPeer.allow_object_decoding.
Break ABI compatibaility (API compatibility for GDNative).
2019-04-01 15:53:19 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
1aa7e22b67
Clear up eof_reached function, fixes #16919
2019-02-17 09:05:32 -03:00
33d8c19999
doc: Add caveat for File.file_exists for imported resources
...
Fixes #25347 .
2019-01-26 20:25:36 +01:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
daa9092ed3
doc: Sync classref with current source
2018-11-20 09:34:45 +01:00
48166a9f3c
Add store_csv_line method for File
2018-11-16 11:09:05 +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
Hugo Locurcio
Rémi Verschelde
kobewi
Rémi Verschelde
Max Hilbrunner
Aaron Franke
Levi Lindsey
Pedro J. Estébanez
Marcel Admiraal
HaSa1002
Ryan Roden-Corrent
skyace65
Maganty Rushyendra
codetorex
Danil Alexeev
clayjohn
shartte
Fabio Alessandrelli
Juan Linietsky
Kanabenki