26f4848d01
Merge pull request #53455 from briansemrau/thread-is-executing
...
[core_bind] Add `Thread::is_alive`. Replace `is_active` with `is_started` to align with core/os/Thread API.
2021-10-06 21:20:33 +02:00
f28c677f3d
[core_bind] Add `is_alive` to Thread. Replace `is_active` with `is_started`.
...
Replacing `is_active` resolves an API discrepancy between core_bind Thread and core/os Thread.
2021-10-06 12:47:58 -04:00
862994a8ef
doc: Update links to latest documentation after content reorganization
2021-10-06 13:48:48 +02:00
97c68514c4
Use Callable in Thread::start
2021-09-25 22:07:13 +09:00
7b846e3f01
Merge pull request #46656 from zaksnet/improve-thread-docs
...
Improve documentation for Thread
2021-09-09 14:10:35 +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
04688b92ff
Rename Reference to RefCounted
2021-06-11 18:48:42 +02:00
9e2882a989
Improve docs for Thread
...
An attempt to improve the documentation for Thread
- Adds documentation on how and when the `wait_to_finish` should be used
- Adds a note on what to be careful about when using `wait_to_finish`
2021-03-04 16:56:54 +01:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
dec20883c1
Document the GDScript debugger not supporting Thread yet
...
See https://github.com/godotengine/godot/issues/2446 .
2020-08-29 02:24:07 +02:00
aa08023115
Add information to get thread id
2020-08-27 22:11:35 -04:00
f50a4b8a3b
Link to Thread-safe APIs in the Thread class documentation
...
This closes https://github.com/godotengine/godot-docs/issues/2276 .
2020-07-30 12:18:00 +02:00
d09644dff3
Clarify docs for Thread.start() godotengine#36032
...
* Updated docs for Thread.start() to specify that the method argument
must accept one parameter.
2020-03-30 21:53:39 -05:00
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +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
c09b9c488f
Complete documentation of some more classes
2020-01-14 13:19:39 +01:00
61510102ec
Added link to tutorial for Thread class
2019-10-02 19:21:23 +03: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
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
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
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
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
d516aab8fa
doc: Sync with current source
...
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
b302084395
makerst: Fix rst-ization of members and escaping of [Class]s
...
Fixes #11517 .
2017-10-21 12:33:52 +02:00
4f929a0fdf
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
...
recognize them.
2017-09-12 17:45:41 -03:00
Rémi Verschelde
Brian Semrau
Rémi Verschelde
LATRio
Max Hilbrunner
Pedro J. Estébanez
Zak
Aaron Franke
Hugo Locurcio
skyace65
Zak Grumbles
clayjohn
Tomasz Chabora
Yuri Roubinsky
Ignacio Etcheverry
Juan Linietsky