Yuri Sizov
39f46613bb
Backport fixes to documentation for paths, curves and navigation servers
2022-08-19 15:52:03 +03:00
Rémi Verschelde
0a8d5d7098
Bump version to 3.6-beta
2022-08-05 18:51:38 +02:00
Hugo Locurcio
1bdcba2d76
Document workarounds for 2D line and polygon antialiasing
2022-04-29 19:39:11 +02:00
Hugo Locurcio
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
Hugo Locurcio
ac0d37dcef
Add a property hint for the Line2D Round Precision property
...
This prevents choosing extremely high values which cause performance
issues for no visual benefit.
(cherry picked from commit 6b52aa67b8
)
2022-02-17 09:59:28 +01:00
Haoyu Qiu
144e3cd31f
Fix various misused code tag in classref
...
(cherry picked from commit 85c136bd07
)
2021-12-02 17:31:16 +01:00
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
LoipesMas
7f0094ca9f
Add note about batching to Line2D's anti-aliasing
...
(cherry picked from commit b047430702
)
2021-09-14 13:41:25 +02:00
Rémi Verschelde
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
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
Aaron Franke
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
)
2020-10-19 16:10:01 +02:00
skyace65
cd2da16d63
Clarify points in Line2D doc
...
(cherry picked from commit 3c9c541c59
)
2020-08-21 02:28:18 +02:00
Hugo Locurcio
8ea77b96b2
Mention 2D polygon limits and how to increase them in the documentation
...
This closes #21793 .
2020-01-28 22:04:29 +01: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
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
PouleyKetchoupp
e6ebc43d72
Fixed antialiased option for Polygon2D / Line2D
...
Polygon2D:
The property wasn't used anymore after switching from canvas_item_add_polygon() to canvas_item_add_triangle_array() for drawing.
Line2D:
Added the same property as for Polygon2D & fixed smooth line drawing to use indices correctly.
Fixes #26823
2019-11-28 22:57:27 +01:00
Rémi Verschelde
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
Rémi Verschelde
266dc732ba
doc: Sync classref with current source
2019-07-02 12:04:26 +02:00
Rémi Verschelde
e4a50999c0
Merge pull request #28565 from CedNaru/CurvedWidthLine2D
...
Added a Width Curve to Line2D + UVs fix
2019-07-01 09:38:54 +02:00
Rémi Verschelde
850a54a2a5
Fix uninitialized variables in Line2D, JSONParseResult and TileMap
2019-06-30 13:58:07 +02:00
Rémi Verschelde
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02: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
Hugo Locurcio
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
Rémi Verschelde
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
Tristan Grespinet
14f8ed3317
Added a Width Curve to Line2D + UVs fix
2019-06-19 15:44:07 +02:00
Rémi Verschelde
6e1b8b07b9
Merge pull request #27805 from Kanabenki/line2d-add-point-idx
...
Add optional position argument for add_point in Line2D
2019-04-30 11:02:47 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Kanabenki
714953b3ac
Add optional position argument for add_point in Line2D
2019-04-08 11:29:13 +02:00
Rémi Verschelde
434b73bc57
Merge pull request #27240 from Chaosus/clear_line_points
...
Added method to clear all points in Line2D
2019-04-05 15:44:14 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Chaosus
61b22beeae
Added method to clear all points in Line2D
2019-03-19 20:32:10 +03:00
Jorn Van denbussche
d7aa3e33c8
Line2D texture stretch mode
...
Prototype for stretching the texture across the whole line.
Fixed end cap tile mode.
2018-07-16 23:16:58 +02: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
luz.paz
612ab4bbc6
Fix typos with codespell
...
Found via `codespell -q 3 --skip="./thirdparty,./editor/translations" -I ../godot-word-whitelist.txt`
Whitelist consists of:
```
ang
doubleclick
lod
nd
que
te
unselect
```
2018-02-21 19:46:06 +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
9f479f096c
Fix typos in code and docs with codespell
...
Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 22:01:42 +01:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Rémi Verschelde
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +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
Martin Capitanio
7c3ba6f72b
Fix the class docs for the rst-syntax errors.
...
- Generate a correkt rst-syntax for the [/code] inline markup.
(http://www.sphinx-doc.org/en/1.6.5/rest.html#inline-markup )
- Fix xml souce bugs
for the sphinx's rst syntax werrors:
class_area.rst:319: WARNING: Inline literal start-string without end-string.
class_area2d.rst:287: WARNING: Inline literal start-string without end-string.
class_audioserver.rst:287: WARNING: Inline literal start-string without end-string.
class_control.rst:509: WARNING: Inline literal start-string without end-string.
class_image.rst:422: WARNING: Inline literal start-string without end-string.
class_image.rst:434: WARNING: Inline literal start-string without end-string.
class_inputevent.rst:74: WARNING: Inline literal start-string without end-string.
class_inputeventaction.rst:45: WARNING: Inline literal start-string without end-string.
class_inputmap.rst:47: WARNING: Inline literal start-string without end-string.
class_kinematicbody.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string.
class_kinematicbody2d.rst:80: WARNING: Inline interpreted text or phrase reference start-string without end-string.
class_line2d.rst:182: WARNING: Inline literal start-string without end-string.
class_thread.rst:51: WARNING: Inline literal start-string without end-string.
class_treeitem.rst:160: WARNING: Inline literal start-string without end-string.
2017-11-19 20:47:36 +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
Unknown
17011f5d12
Added documenation for Line2D
...
[ci skip]
2017-10-09 11:45:41 +02:00
letheed
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
Rémi Verschelde
62cb43bb8d
doc: Sync classref with current source
...
[ci skip]
2017-09-16 01:46:29 +02: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