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
8898d6dadc
Dictionary: Serialize empty dict as {} instead of {\n}
...
Also make sure to always convert multiline dictionaries to a single line for
its EditorHelp representation, as multiline values break formatting.
2022-01-18 11:31:21 +01:00
4682f22293
Improve various texts
2021-11-23 12:20:57 +01:00
8d6f80d367
Add property value pinning
2021-11-08 17:42:30 +01:00
85819b199a
Rename RigidBody to RigidDynamicBody and SoftBody to SoftDynamicBody
2021-09-16 09:55:20 -07: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
e28fd07b2b
Rename instance()->instantiate() when it's a verb
2021-06-19 20:49:18 -06:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
7368bc534a
fixed typo in packedscene
2021-02-11 13:22:44 -08:00
a3df26e554
Docs: Port Code Examples to C# (M, N, O, P, R)
...
Includes:
* MarginContainer
* NavigationPolygon
* Node
* NodePath
* OS
* PackedByteArray
* PackedScene
* PacketPeerUDP
* PCKPacker
* Performance
* PhysicsShapeQueryParameters2D
* PhysicsShapeQueryParameters3D
* PrimitiveMesh
* ProjectSettings
Co-authored-by: Aaron Franke <arnfranke@yahoo.com >
2020-11-09 10:05:53 +01:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
23d929d540
Document how to instance a PackedScene and add it as a child
...
This information was already present in `@GDScript.preload()`,
but it's not easy to find.
This closes https://github.com/godotengine/godot-docs/issues/3338 .
2020-07-09 20:05:33 +02:00
2f46f1e7b1
Check for errors when saving in the ResourceSaver example documentation
...
This also replaces a non-breaking space that was accidentally added in
the EditorFeatureProfile documentation.
This closes #31393 .
2020-04-17 22:29:05 +02:00
a7e1df4b1d
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 22:02:36 +01:00
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
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
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
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
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
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
693ee5dd56
Fixed typos
2018-11-04 22:15:11 +01:00
22b7489ab1
doc: Fix invalid [enum] uses
2018-10-31 13:01:54 +01:00
7a42df3626
doc: Sync with current source
2018-10-25 15:14:47 +02:00
725bec7735
more detailed example for usage of PackedScene
2018-10-24 16:01:50 +01:00
b1ab7b4acf
[Docs] Fix some broken links
2018-10-06 04:20:16 +08:00
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
13d5ee01f9
[DOCS] Node & PackedScene ( #17833 )
...
* [DOCS] Node: SceneSaver -> PackedScene
* [DOCS] PackedScene: Code example, resolve TODO
2018-03-28 23:07:03 +02: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
9f341971c9
[DOCS] PackedScene member/method/class descs.
2017-12-04 14:28:37 -06: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
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +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
