b087538119
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-03-16 23:01:02 +01:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
f5836b40d4
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.
(cherry picked from commit 7adf4cc9b5
2021-08-03 10:20:19 +02:00
bd8747f7f1
Fix miscellaneous doc typos and inconsistencies
...
This pull request fixes an assortment of typos, improves conciseness, and enhances clarity.
(cherry picked from commit 9787e631aa
2021-07-24 01:00:37 +02:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
ad413a613c
Document `AStar.get_point_path()` not being thread-safe
...
(cherry picked from commit cf64bad63e
2021-04-20 20:14:47 +02:00
596169d7df
class reference proofreading
...
(cherry picked from commit 8455e901f3
2021-03-26 09:49:07 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
90d1d580af
Explain A Star pathfinding algorithm cost calcuation
...
(cherry picked from commit f6634648ce
2021-01-05 21:33:33 +01:00
51de6732c9
AStar: Make get_closest_point() deterministic for equidistant points
...
Closes godotengine/godot-docs#3667.
Supersedes #39405 .
(cherry picked from commit 187ba4c5a8
2020-06-10 15:30:52 +02: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
ed373a60b1
Merge pull request #30556 from kawa-yoiko/astar-directed
...
Improve support for directed graphs in A*; docs update included
2019-11-07 12:33:27 +01:00
79298face0
doc: Sync classref with current source
2019-10-01 10:58:48 +02:00
add0004a78
Revise and update AStar documentation
2019-09-11 15:41:42 +08:00
1031833fb0
allow to reserve space in OAHashMap explicitly and also in AStar.
...
* also handle overflow occurring in _get_probe_length
2019-08-27 00:38:35 +02:00
d7cf3c8e72
AStar and AStar2D examples fixed to not use 'as' keyword and also removed error causing code
2019-07-20 15:06:58 +05:30
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
71d53637b5
doc: Fix scoped hyperlinks to same-class enums/methods
...
The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
0bc37de744
Added 2D functions to AStar
2019-05-30 07:10:07 +03:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
3cf2bdbd84
Merge pull request #27506 from Chaosus/astar
...
Added functions to AStar for disable/enable points to effectivly create obstacles
2019-04-08 12:19:51 +02:00
cc71fb2308
Added functions to AStar for disable/enable points
2019-04-08 09:28:03 +03:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
e588c24168
doc: Fix formatting in code blocks
2018-12-14 09:37:19 +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
8d03cafd7c
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
2b41afb30e
Fix wrong return value in some virtual method bindings
2017-12-10 15:34:08 +01:00
5b820bc247
[DOCS] ARVR, AStar, AtlasTexture, Basis
2017-12-07 00:16:27 -06: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
2fce0010f0
classref: Sync with current source
...
[ci skip]
2017-11-13 09:25:53 +01:00
4c79e58e3f
AStar: implementation of get_point_connections
2017-11-04 11:21:03 +03:00
9b4c5989ad
AStar: Add setters for point position and scale weight, cleanup
2017-10-27 19:19:01 +02:00
5ad9be4c24
Rename pos to position in user facing methods and variables
...
Rename user facing methods and variables as well as the corresponding
C++ methods according to the folloming changes:
* pos -> position
* rot -> rotation
* loc -> location
C++ variables are left as is.
2017-09-20 13:11:10 +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
Hugo Locurcio
Rémi Verschelde
Nicholas Huelin
Paul Joannon
Maganty Rushyendra
Shiqing
Robin Hübner
unknown
Chaosus
Will Nations
DmDerbin
Unknown
letheed
Juan Linietsky