1df86ecea5
[doc] Use "param" instead of "code" to refer to parameters (4)
2022-08-11 13:52:19 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
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
eb9100f085
Fix divide by zero in pck_packer
2021-11-17 18:07:29 +00:00
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05: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
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
f043eabdd8
Adds PCK encryption support (using script encryption key for export).
...
Change default encryption mode from ECB to CFB.
2020-09-05 14:53:39 +03: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
3684810a28
Merge pull request #34164 from Calinou/pckpacker-optional-args
...
Make some arguments in PCKPacker methods optional
2019-12-09 09:41:52 +01:00
fe06966181
Make some arguments in PCKPacker methods optional
...
Those arguments aren't required for most common use cases,
so making them optional should help with code readability.
2019-12-07 01:06:42 +01:00
7ae0e4be46
Improve the PCKPacker class documentation
2019-12-07 01:00:51 +01:00
fa45fdb5f5
doc: PCKPacker class example code
2019-11-12 23:15:29 +01: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
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
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
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
Andy Maloney
Yuri Sizov
Hugo Locurcio
Paulb23
Aaron Franke
Rémi Verschelde
Pedro J. Estébanez
HaSa1002
bruvzg
clayjohn
IlyaStuurFedorov
Juan Linietsky