Rémi Verschelde
383c678a1e
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
...
(cherry picked from commit bc82781f7d
)
2019-07-29 17:32:54 +02:00
Aspin
26e25a8c1b
More accurate description of valid Parents
...
I hope this is the right place to edit now.
(cherry picked from commit a9ddf2a449
)
2019-07-29 15:55:34 +02:00
Rémi Verschelde
24f17f2208
doc: Fix DocData.merge_from copying old setters and getters
...
This is not necessary and means that some setters and getters
can end up wrong if they are changed in the bindings but DocData
does not update them when running --doctool.
Fixes #29425 .
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
(cherry picked from commit e1e3fcc908
)
2019-07-29 15:16:17 +02:00
Sean Heffernan
d846a0aaa3
Change "Return" to "Returns" where necessary in XML documentation
...
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".
Fixes #28867
(cherry picked from commit 426bcc9941
)
2019-07-29 15:12:52 +02:00
Tomasz Chabora
dea5dafea5
Consistently wrap booleans in [code]
...
(cherry picked from commit b0846f60c9
)
2019-07-29 14:54:32 +02:00
Rémi Verschelde
df6a6a2004
doc: Sync classref with current source
2019-07-05 11:34:47 +02:00
Rémi Verschelde
f156b2e1cd
doc: Make all tutorial links track "3.1" in 3.1 branch
...
See discussion in #29104 .
2019-06-01 11:39:37 +02:00
Rémi Verschelde
a485d862f1
doc: Sync classref with current source
2019-04-25 14:00:31 +02:00
Rémi Verschelde
53d73f59eb
doc: Drop unused <demos> tag
...
(cherry picked from commit 6af69f851a
)
2019-04-19 13:10:25 +02:00
Rémi Verschelde
d1f68e2eaf
Add tooltip for in-editor FPS display in 3D viewport
...
Also enhance Control/Label documentation about tooltips and mouse filter,
as it took me a while to understand why Labels didn't show tooltips.
Closes #26082 .
2019-02-20 12:16:22 +01:00
Rémi Verschelde
5fc86026ca
Fix typos with codespell
...
Using codespell 1.14.0.
Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
doubleclick
lod
nd
numer
que
te
unselect
EOF
$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```
2019-02-13 09:23:29 +01:00
danboo
aca6e5f4b7
Update Control.xml
...
The mouse_filter documentation was biased towards button click events, so add more mention of its impact on mouse_entered and mouse_exited signals as well.
2019-01-21 21:39:06 -09:00
Rémi Verschelde
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
Rémi Verschelde
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
Rémi Verschelde
53516d7a9e
Merge pull request #24608 from PJB3005/18-12-26-control-docs
...
Improve documentation of Control.
2019-01-06 13:15:15 +01:00
Pieter-Jan Briers
c93c279867
Improve documentation of Control.
2019-01-04 18:12:24 +01:00
Rémi Verschelde
ee6f1fa3f8
doc: Fix references to setters and misc formatting
2018-12-29 00:17:09 +01:00
Rémi Verschelde
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
Kelly Thomas
b1ab7b4acf
[Docs] Fix some broken links
2018-10-06 04:20:16 +08:00
LikeLakers2
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
Rémi Verschelde
c320d9394d
doc: Sync classref with current source
2018-09-11 00:18:21 +02:00
Kelly Thomas
29f2571662
update class docs
2018-08-31 22:35:15 +02:00
Mel Collins
2d0a55c86c
Clarify direction of input event propagation
2018-08-26 15:14:55 +02:00
Rémi Verschelde
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
Chris Bradfield
23b7edb214
[DOCS] Updates to assorted class descriptions.
2018-08-17 14:55:19 -07:00
Michael Alexsander Silva Dias
79ab43299a
Small doc formating changes and Linux cursor theme note
2018-08-05 04:07:04 -03:00
Rémi Verschelde
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
robojumper
98b59cf2a3
Add support for tutorial links to makerst.py
...
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
Kelly Thomas
c6ed46891d
[docs] fix links in class docs
2018-05-17 00:15:30 +08:00
Rémi Verschelde
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
Poommetee Ketson
a88ee7d920
[Docs] fix typos
2018-03-29 12:46:21 +07: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
indicainkwell
7154a96d3f
added docs on Control's drag and drop api
2018-02-26 15:54:08 -08:00
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
Michael Alexsander Silva Dias
5e0821e867
Small fixes for the Control description in the docs.
2018-02-01 19:43:44 -02:00
Rémi Verschelde
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +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
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
Juan Linietsky
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
letheed
524ee14054
Small fix for Control bindings
2018-01-13 09:40:42 +01:00
Bojidar Marinov
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
Rémi Verschelde
7251c5b582
Improve Control and Label documentation about mouse filtering
...
Fixes #9657 .
2018-01-09 17:40:19 +01:00
PJB3005
305ab94431
Document Control.mouse_filter and its constants.
2018-01-04 18:20:19 +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
Rémi Verschelde
15ada56d73
doc: Sync classref with current source
2017-11-24 09:16:27 +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