godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
46,543 Commits 15 Branches 59 Tags 2.2 GiB
f350356183
Commit Graph

66 Commits

Author SHA1 Message Date
Fabio Alessandrelli
d20b32186f [Web] Rename JavaScript platform to Web. 
Also rename export name from "HTML5" to "Web".
 2022-08-29 11:52:00 +02:00
Andy Maloney
ea2192b99e [doc] Use "param" instead of "code" to refer to parameters (6) 2022-08-12 12:07:53 -04:00
Yuri Sizov
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
Hugo Locurcio
9709205112
Fix broken rST reference in HTTPClient documentation 
References in reStructuredText cannot be located within bold/italic
text. This caused the online class reference to have the `:ref:`
text written as-is.
 2022-08-07 07:21:29 +02:00
Hugo Locurcio
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
Haoyu Qiu
c09ea8d45a Adds proxy support for HTTPClient 
Also fixed a potential infinite loop when connecting to server.
 2021-11-24 14:36:42 +08:00
Rémi Verschelde
6c1bd4d227
Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 13:02:21 +01:00
Hugo Locurcio
7a62bd1e44
Document Android permission requirements for network access where needed 2021-09-25 12:32:46 +02:00
Max Hilbrunner
90283b6645 Add new docs warning from HTTPRequest to HTTPClient 2021-09-07 18:55:15 +02:00
Aaron Franke
ae1702bee5
Replace HTTP links with HTTPS for sites with HTTPS versions 2021-08-22 20:13:11 -05:00
Max Hilbrunner
4eb427afb8 Docs: Add warnings about no SSL/(D)TLS revocation 2021-08-11 16:02:38 +02:00
Rémi Verschelde
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
Haoyu Qiu
422f821be9 Fix doc description of HTTPClient::request 2021-07-11 00:52:21 +08:00
Pedro J. Estébanez
04688b92ff Rename Reference to RefCounted 2021-06-11 18:48:42 +02:00
Paul Joannon
8455e901f3
class reference proofreading 2021-03-19 13:21:20 +01:00
Aaron Franke
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
HaSa1002
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
Rémi Verschelde
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
Hugo Locurcio
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
Hugo Locurcio
0ebbc7602c
Document the supported TLS versions in HTTPRequest 
See #42857.
 2020-10-17 14:49:56 +02:00
Hugo Locurcio
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
Hugo Locurcio
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
Hugo Locurcio
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
Rémi Verschelde
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
clayjohn
57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08:00
Rémi Verschelde
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
Rémi Verschelde
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
Muller-Castro
f9db01ec50 Fixed HTTPClient.xml:115 and 121 variant declaration 2019-12-12 15:40:17 -03:00
Rémi Verschelde
4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
Fabio Alessandrelli
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
Hugo Locurcio
04d3146b75
Mention body length getter caveats in HTTPClient and HTTPRequest 2019-10-22 20:16:41 +02:00
Yeongho Kim
d4a55fb639 Print errors when tab indent found in [codeblock] 2019-10-01 23:39:45 +09:00
Rémi Verschelde
a78373ddc2 doc: Remove null default values that can't be determined 
Applying #30187.
 2019-06-30 13:58:07 +02:00
Rémi Verschelde
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
Hugo Locurcio
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
Rémi Verschelde
bc82781f7d doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 13:49:36 +02:00
Rémi Verschelde
86ed7a9884 doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 11:10:53 +02:00
Rémi Verschelde
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code 
Consistently wrap booleans in [code]
 2019-04-22 11:59:16 +02:00
Rémi Verschelde
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Tomasz Chabora
b0846f60c9 Consistently wrap booleans in [code] 2019-04-17 17:13:00 +02:00
Rémi Verschelde
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough 
EditorHelp: Improve enum ref resolving and add constant ref support
 2019-04-05 15:19:21 +02:00
Rémi Verschelde
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Ignacio Etcheverry
d80bc5cbba ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] 
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
 2019-03-29 23:47:35 +01:00
Rémi Verschelde
6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Rémi Verschelde
e588c24168 doc: Fix formatting in code blocks 2018-12-14 09:37:19 +01:00
Rémi Verschelde
5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch 
Fixes #23509.
 2018-11-05 08:46:27 +01:00
robojumper
98b59cf2a3 Add support for tutorial links to makerst.py 
Also change the <tutorials> structure to make use of individual <link> tags
 2018-06-12 17:40:24 +02:00
Pedro J. Estébanez
8d8e9d54c8 Enhance HTTPClient.query_string_from_dict() 2018-03-27 19:18:32 +02:00
Rémi Verschelde
3fa77b3172 doc: Remove status from hardcoded version string 
It has no practical use case and just generates noise for each alpha, beta, etc.
 2018-02-27 13:40:49 +01:00
luz.paz
612ab4bbc6 Fix typos with codespell 
Found via `codespell -q 3 --skip="./thirdparty,./editor/translations" -I ../godot-word-whitelist.txt`
Whitelist consists of:
```
ang
doubleclick
lod
nd
que
te
unselect
```
 2018-02-21 19:46:06 +01:00