Commit Graph

46 Commits

Author SHA1 Message Date
606284e14b Fix minor grammar error in CollisionPolygon2D, CollisionPolygon3D, CollisionShape2D, and CollisionShape3D docs 2025-09-17 11:43:20 +12:00
bf6d94b561 Merge pull request #102520 from Giganzo/CollisionShape3D-disabled-doc
Add info about `set_deferred` for CollisionShape3D disabled property
2025-06-07 00:43:26 +02:00
1e82bafa3a Remove redundant info on the enum types used 2025-06-04 08:21:47 +08:00
b76b949d42 Add info about set_deferred for setting CollisionShape3D disabled property 2025-02-09 23:17:42 +01:00
54a4a874fa Fix warning in CollisionPolygon2D documentation description
This was a copy-paste error from the CollisionShape2D documentation.
2025-01-04 17:53:19 +01:00
23782b898b Add further details on properties returning Packed*Array 2024-04-08 11:35:27 +02:00
b6f07a007a Fix concave CollisionPolygon2D debug drawing and docs 2024-03-23 18:51:39 +01:00
f781571d07 Add keywords to improve search in the class reference 2024-02-22 16:16:49 +01:00
f5409dc132 Mention CollisionPolygon2D.polygon is local to the given CollisionPolygon2D 2024-01-10 11:14:57 +08:00
7512d88e22 Fix some mixups between 2D/3D in documentation 2023-07-23 09:02:52 +02:00
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
346f1ab86b Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
e3d0da404f Overhaul the top sections of the class reference (Physics classes) 2023-05-20 03:25:26 +02:00
e61a127042 Fix concave/convex polygon shape documentation
Removes some outdated/incorrect/duplicated info, adds correct info.
Also removes no longer applicable "editor-only helper" statements.
2023-03-05 17:19:50 +01:00
1c1524a651 Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
c836bdf5b1 Mention that Area2D doesn't support one_way_collision 2022-05-09 15:00:53 +02:00
a30e5805af Improve documentation related to physics collision shapes
- Document using convex decomposition in the editor.
- Mention that "trimesh" is synonymous with a concave collision shape.
- Add performance hints for each collision shape.
2022-03-02 20:28:43 +01: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
d54f2ad7ca Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05:00
0ff4095b36 Better format arguments in variant parser 2021-06-18 00:06:40 -03:00
e103f21a40 Add LOTS of missing docs 2020-03-13 16:35:03 +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
4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
b9aa13e591 doc: Remove hardcoded default values from descriptions
They are now generated automatically by doctool.
2019-06-30 13:58:07 +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
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
ec94370053 Add warnings to docs for methods that return copies, not refs. 2019-02-19 20:03:40 -08:00
433b8ee526 doc: Sync classref with current source 2019-01-26 22:21:53 +01:00
6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01: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
7dfba3cda9 doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00
92f07fefcd doc: Remove setters and getters now exposed via properties/members 2017-11-24 18:10:32 +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
ee1afc8bca [DOCS] Update Polygon2D and CollisionPolygon2D 2017-10-02 09:36:09 -07:00
60a929d18e Modified the descriptions for CollisionPolygon2D and created descriptions for CollisionPolygon 2017-09-16 18:42:47 -07:00
62cb43bb8d doc: Sync classref with current source
[ci skip]
2017-09-16 01:46:29 +02: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