28e66882e5
[doc] Fix grammar in class docs: amount vs. number
...
Number is used for things that can be counted (discrete items - think "integer" in this context).
Also fixes a couple of awkward phrases.
2022-08-17 19:51:17 -04:00
ea2192b99e
[doc] Use "param" instead of "code" to refer to parameters (6)
2022-08-12 12:07:53 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
5f0cad8cfa
Document the `timeout` property in HTTPRequest
2022-07-08 23:24:45 +02:00
d2900429e8
Add static methods for creating Image and ImageTexture
2022-07-08 13:40:47 +02:00
c894ae0b6b
Make code example in HTTPRequest classref working
...
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2022-06-24 23:29:52 +08:00
4a95408dd4
[Net] Change HTTPRequest timeout type to double.
...
For consistency with the Timer class and general time representation
inside the engine.
2022-03-27 18:15:56 +02: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
5912dd2964
Add proxy support for the editor
...
* Adds proxy support for `HTTPRequest`.
* Adds `network/http_proxy/{host,port}` editor settings.
* Labeled as "HTTP Proxy" and it will be used for both HTTP and
HTTPS requests. This is the same convention as seen in Android
Studio's proxy settings.
* Makes Asset Library and Export Template Manager use proxy according to
the editor settings.
2021-12-09 11:48:16 +08:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
7a62bd1e44
Document Android permission requirements for network access where needed
2021-09-25 12:32:46 +02:00
75530c5977
security tip when sending sensitive data on HTTP requests
2021-09-07 11:48:31 -03:00
1ed3d9a0b0
improving note on HTTPRequest class under the request method documentation
2021-09-03 11:10:33 -03:00
4eb427afb8
Docs: Add warnings about no SSL/(D)TLS revocation
2021-08-11 16:02:38 +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
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
e829b7aee4
Unify URI encoding/decoding and add to C#
...
http_escape and percent_encode have been unified into uri_encode, and http_unescape and percent_decode have been unified into uri_decode.
2021-01-28 07:45:01 -05: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
709964849f
Merge pull request #42896 from Calinou/httprequest-increase-chunk-size
...
Increase the default HTTPClient download chunk size to 64 KiB
2020-11-07 16:38:28 +01:00
13357095ee
Increase the default HTTPClient download chunk size to 64 KiB
...
This improves download speeds at the cost of increased memory usage.
This change also effects HTTPRequest automatically.
See #32807 and #33862 .
2020-11-07 16:11:04 +01:00
aba611b6fc
Merge pull request #42870 from Calinou/doc-httprequest-tls-version
...
Document the supported TLS versions in HTTPRequest
2020-11-06 14:32:45 +01:00
d7025c4167
Fix a variable being redeclared in the HTTPRequest code sample
2020-10-31 19:20:18 +01:00
0ebbc7602c
Document the supported TLS versions in HTTPRequest
...
See #42857 .
2020-10-17 14:49:56 +02: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
a2a78a8066
doc: Sync classref with current source
...
Bind missing enums.
2020-09-11 12:22:10 +02:00
6584db1538
HTTPRequest now accepts gzip
...
Added request_raw to HttpRequest
Added decompress_dynamic to Compression class
Added decompress_dynamic to BytePoolArray
Merge doc fix
revert
2020-09-02 12:59:59 -07: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
2f577facc9
Document HTTPRequest not supporting request data with GET method
...
This also improves the HTTPClient class documentation to be easier
to read and more informative.
This closes #40564 .
2020-08-03 14:57:27 +02:00
90db42d9db
Document HTML5 CORS restrictions in HTTPClient and HTTPRequest
...
See https://github.com/godotengine/godot/issues/40247 .
2020-07-20 15:15:55 +02:00
54db59be67
Add a POST request example to the HTTPRequest class documentation
2020-07-10 09:13:46 +02: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
ba177ccaec
doc: Misc updates for AnimationNode* and others
...
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
* Make `AnimationNodeTransition.input_<number>` properties internal
so that they don't appear in the docs. They still appear in the
inspector based on the actual number of inputs requested.
* Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
particles in `ParticlesMaterial`, and thus only relevant for
`CPUParticles3D`.
2020-01-23 12:37:33 +01:00
c719cea116
Add an example of using HTTPRequest to contact a REST API
...
We already had an example to download and display an image,
but having another example dedicated to REST APIs doesn't hurt.
2019-12-24 23:24:16 +01:00
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
ed19b4076e
Add download_chunk_size property to HTTPRequest.
...
This allows setting the `read_chunk_size` of the internal HTTPClient.
This is important to reduce the allocation overhead and number of file
writes when downloading large files, allowing for better download speed.
2019-11-24 19:32:20 +01:00
06fc43d41c
Add an HTTPRequest usage example to the class reference
...
This also adds a link to the "Making HTTP requests" tutorial.
2019-11-07 16:49:21 +01:00
04d3146b75
Mention body length getter caveats in HTTPClient and HTTPRequest
2019-10-22 20:16:41 +02:00
1abe12f5bb
doc: Sync classref with current source
2019-07-10 16:06:23 +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
528c4722d6
doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred
2019-06-27 14:43:37 +02:00
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
ee6f1fa3f8
doc: Fix references to setters and misc formatting
2018-12-29 00:17:09 +01:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +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
Andy Maloney
Yuri Sizov
Hugo Locurcio
kobewi
Haoyu Qiu
Fabio Alessandrelli
Rémi Verschelde
Arthur Paulino
Max Hilbrunner
Michael Alexsander Silva Dias
Paul Joannon
Aaron Franke
HaSa1002
Adam Brown
clayjohn