Yuri Sizov
cc0eebd9d8
Validate code
tags for class and member references
...
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.
Warnings are now enabled on CI to prevent future errors.
2023-10-03 15:48:31 +02:00
Rémi Verschelde
81064cc239
Doctool: Remove version attribute from XML header
...
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
Rémi Verschelde
346f1ab86b
Bump version to 4.2-dev
...
Keep on waitin'
2023-07-05 22:07:03 +02:00
Danil Alexeev
eb391d3302
Display BitField[Enum]
in docs to distinguish from Enum
2023-06-15 17:23:02 +03:00
VolTer
151a4ba6a5
Overhaul the top sections of the class reference (GUI classes)
2023-05-28 14:24:54 +02:00
Rémi Verschelde
1c1524a651
Bump version to 4.1-dev
...
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
Juan Linietsky
47592927b3
Use BitField<> hint for ArrayFormat
...
This was missing in the conversion of bitflags to BitField<>.
2023-01-08 18:47:48 +01:00
kobewi
a23f6d0aa6
Fill random docs
2022-11-22 17:59:45 +01:00
Aaron Franke
a3e52925bf
Fix default values on virtual classes causing errors in projects
2022-11-09 01:59:53 -06:00
Haoyu Qiu
3aed3edc06
Allow selecting SpinBox & LineEdit text when focus enters
2022-10-29 09:58:42 +08:00
Jóhannes Gunnar Þorsteinsson
ba35cff303
Independent spinbox arrow step precision
...
Rebased by EIREXE
This work has been kindly sponsored by IMVU & EIRTeam.
2022-08-04 14:48:46 +02:00
kobewi
c8de265307
Mention how to add dragging for SpinBox's LineEdit
2022-04-03 19:40:14 +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
Nathan Franke
41a20171eb
align to horizontal_alignment, valign to vertical_alignment, related
2021-12-09 01:38:46 -06:00
Yuri Sizov
07725b611b
Add warnings to methods that give access to internal nodes
2021-10-10 22:57:58 +03:00
Eric M
baba971c81
Added option for spinbox to update it's value on line edit 'text_changed' rather than 'text_entered'
2021-09-21 23:24:33 +10:00
Aaron Franke
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05:00
Yuri Sizov
bf2839ea3e
Add theme item descriptions to the online documentation
2021-08-04 22:27:10 +03: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
bae843a1c9
Docs: Port Code Examples to C# (R, S, T, U)
...
* RenderingServer
* RichTextEffect
* SceneTree
* SceneTreeTimer
* ScriptCreateDialog
* SpinBox
* Sprite2D
* StreamPeer
* String
* SurfaceTool
* TextEdit
* TileMap
* Tree
* Tween
* UDPServer
* UndoRedo
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2021-03-05 18:57:28 +01:00
Hugo Locurcio
159581739a
Document theming a SpinBox's background
...
This closes #46248 .
2021-02-21 19:32:11 +01:00
follower
ae067413a5
Fix suffix property doc typo: "prefix" -> "suffix"
2020-05-06 05:00:12 +12: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
7f9bf5472c
doc: Sync classref with current source
2020-01-12 14:30:21 +01:00
Jóhannes Gunnar Þorsteinsson
083637a901
Add apply method to SpinBox
2020-01-11 10:47:51 +00: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
Zak
f9cbd34fe0
Document SpinBox node
2019-06-29 11:13:02 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Kelly Thomas
b150ceb62c
Update class documentation xml
2018-10-07 21:57:26 +08: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
92f07fefcd
doc: Remove setters and getters now exposed via properties/members
2017-11-24 18:10:32 +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
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +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