Paul Joannon
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
TechnoPorg
81dc9be973
Fix incorrect parameter in audio_track_set_key_stream.
...
The description for audio_track_set_key_stream referenced a parameter called offset, which is not a parameter for that method. The description now references the correct parameter, stream.
2021-01-11 18:55:14 -06:00
Rémi Verschelde
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
Marcel Admiraal
f5a3cbda19
Rename Animation::track_remove_key_at_position to track_remove_key_at_time
2020-12-14 18:00:11 +00:00
Rémi Verschelde
a33fe75050
doc: Sync classref with current source
2020-10-09 15:04:15 +02:00
lolligerjoj
ff4af94414
Expose Animation::value_track_interpolate to GDscript
2020-10-01 14:27:09 +02:00
HaSa1002
c5aded55df
Add C# code examples to the docs
...
Only existing GDScript code examples are converted and added to the
docs.
This is the first batch include classes beginning with A and B.
Included classes:
* AcceptDialog
* AESContext
* Animation
* AnimationNodeStateMachine
* AnimationNodeStateMachinePlayback
* AnimationNodeStateMachineTransition
* Array
* ArrayMesh
* AStar
* AStar2D
* Bool
* Button
2020-09-26 12:29:55 +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
4257aa5c5c
Fix incorrect key name in the Animation documentation code sample
...
This closes https://github.com/godotengine/godot-docs/issues/3841 .
2020-07-29 10:13:44 +02:00
Tomasz Chabora
e103f21a40
Add LOTS of missing docs
2020-03-13 16:35:03 +01:00
Rémi Verschelde
a7e1df4b1d
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 22:02:36 +01:00
Rémi Verschelde
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01: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
Rémi Verschelde
0e3d625737
doc: Sync classref with current source
...
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.
Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 12:37:13 +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
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
LikeLakers2
68552d9a4b
Changes the name of all parameters referring to track indices within Animation, to "track_idx"
2019-10-14 18:08:41 -04:00
Rémi Verschelde
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
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
cfb9709c10
doc: Sync classref with current source
2019-06-01 12:34:29 +02:00
Tomasz Chabora
adcbcf87dd
Add track_set_key_time() to Animation
2019-05-31 00:40:29 +02:00
Michael Alexsander Silva Dias
fad0338beb
Make animation editor change tracks positions instead of swapping them
2019-05-27 22:03:26 -03:00
Sean Heffernan
426bcc9941
Change "Return" to "Returns" where necessary in XML documentation
...
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".
Fixes #28867
2019-05-23 21:11:24 -07: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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Rémi Verschelde
7a79eee523
Expose OS::get_current_video_driver to scripting languages
2019-02-16 14:41:07 +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
173b342ca7
Remove trailing whitespace
...
With `sed -i $(rg -l '[[:blank:]]*$' -g'!thirdparty') -e 's/[[:blank:]]*$//g'`
(+ manual revert of some thirdparty code under `platform/android`).
2018-11-20 11:15:02 +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
Michael Alexsander Silva Dias
a02f02b9ed
Add example to Animation doc
2018-10-03 13:17:49 -03:00
Michael Alexsander Silva Dias
79ab43299a
Small doc formating changes and Linux cursor theme note
2018-08-05 04:07:04 -03:00
Rémi Verschelde
f0fa590210
Merge pull request #19526 from robojumper/fix_tutorials
...
Add support for tutorial links to makerst.py
2018-06-13 14:29:45 +02: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
Juan Linietsky
d5bb6faac7
-Make sure that ProjectSettings are properly dumped when dumping docs.
...
-Documented all properties of project settings
Update documentation for ProjectSettings
2018-06-11 13:41:16 -03: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
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
Rémi Verschelde
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +01:00
Rémi Verschelde
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
Rémi Verschelde
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
Juan Linietsky
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Bojidar Marinov
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
Rémi Verschelde
d03f35f1bc
Bind TextEdit.deselect and update documentation
2017-12-16 21:08:31 +01:00
Will Nations
3533e01eab
[DOCS] Animation, CanvasItem, Curve3D, Curve
2017-12-13 23:05:56 -06:00
Rémi Verschelde
ce0f894b48
doc: Sync classref with current source
2017-12-10 00:43:49 +01:00
Will Nations
898078a735
[DOCS] Animation methods desc 100%
2017-12-05 00:02:54 -06:00
Rémi Verschelde
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
Rémi Verschelde
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
Rémi Verschelde
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
Rémi Verschelde
210ebb5cdb
doc: Sync classref with current source
...
[ci skip]
2017-09-23 10:59:41 +02:00
letheed
5ad9be4c24
Rename pos to position in user facing methods and variables
...
Rename user facing methods and variables as well as the corresponding
C++ methods according to the folloming changes:
* pos -> position
* rot -> rotation
* loc -> location
C++ variables are left as is.
2017-09-20 13:11:10 +02:00
Juan Linietsky
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