Andy Maloney
ef942718a0
[doc] Use "param" instead of "code" to refer to parameters (5)
2022-08-15 15:49:48 +03:00
Yuri Sizov
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03: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
Max Hilbrunner
47f7b4b7ca
Merge pull request #43240 from HaSa1002/docs-mainloop
...
Docs: Fix Mainloop example
2021-09-16 02:22:37 +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
HaSa1002
fc30909e05
Docs: Fix Mainloop example
2021-03-22 13:46:38 +01:00
Hugo Locurcio
fcb6ecaf21
Mention that the `delta` argument is in seconds in Node documentation
2021-01-05 19:14:37 +01:00
Rémi Verschelde
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
bruvzg
7e2c0ffd1a
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-11-26 14:25:52 +02:00
HaSa1002
f8ac4c4d75
MainLoop: Remove deprecated methods
2020-11-01 12:38:30 +01:00
Rémi Verschelde
372136fe75
Environment: Refactor code for readability + more
...
- Makes all boolean setters/getters consistent.
- Fixes bug where `glow_hdr_bleed_scale` was not used.
- Split CameraEffects to their own source file.
- Reorder all Environment method and properties declarations,
definitions and bindings to be consistent with each other
and with the order of property bindings.
- Bind missing enum values added with SDFGI.
- Remove unused SDFGI enhance_ssr boolean.
- Sync doc changes after SDFGI merge and other misc changes.
2020-07-01 14:44:45 +02:00
Rémi Verschelde
e5033d3952
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +02:00
bruvzg
1af06d3d46
Rename `scancode` to `keycode`.
...
Add `physical_keycode` (keyboard layout independent keycodes) to InputEventKey and InputMap.
Fix non-latin keyboard layout keycodes on Linux/X11 (fallback to physical keycodes).
2020-02-25 12:30:33 +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
Tomasz Chabora
c09b9c488f
Complete documentation of some more classes
2020-01-14 13:19:39 +01:00
Chris Bradfield
378c4895ae
[DOCS] Corrections and clarifications to classref
2020-01-10 10:46:41 -08:00
Cagdas
0088385556
Add request permission automatically at android
2019-10-22 22:52:13 +03:00
Rémi Verschelde
79298face0
doc: Sync classref with current source
2019-10-01 10:58:48 +02:00
fhuya
a7712cc9e4
Add new events and accompanying logic to notify when the app is paused and resumed on Android devices.
2019-09-19 13:29:49 -07:00
bruvzg
db6d4352ea
[macOS] Add methods to modify global and dock menus. Add ability to open multiple editor/project manager instances, recent/favourite project list to project manager dock menu and opened scene list to editor dock menu.
2019-08-26 16:45:49 +03:00
Tomasz Chabora
7e075029c8
Fix various typos and style errors in text
2019-08-19 20:43:42 +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
867dda1124
doc: Proofread and complete various nodes
...
All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.
Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-26 23:05:51 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +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
bruvzg
4554c682e6
Changes IME input to use notification instead of callback, exposes IME methods to gdscript/gdnative.
2018-11-23 14:07:48 +02:00
Rémi Verschelde
c320d9394d
doc: Sync classref with current source
2018-09-11 00:18:21 +02:00
Rémi Verschelde
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +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
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +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
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01: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
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
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