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
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
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
e1e3fcc908
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>
2019-06-03 13:03:05 +02:00
a9ddf2a449
More accurate description of valid Parents
...
I hope this is the right place to edit now.
2019-05-30 20:41:55 +08:00
426bcc9941
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
2019-05-23 21:11:24 -07:00
86f6d08923
doc: Sync classref with current source
2019-05-21 13:27:03 +02:00
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough
...
EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-05 15:19:21 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
d80bc5cbba
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]
...
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 23:47:35 +01:00
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
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
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
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
53516d7a9e
Merge pull request #24608 from PJB3005/18-12-26-control-docs
...
Improve documentation of Control.
2019-01-06 13:15:15 +01:00
c93c279867
Improve documentation of Control.
2019-01-04 18:12:24 +01:00
ee6f1fa3f8
doc: Fix references to setters and misc formatting
2018-12-29 00:17:09 +01:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
b1ab7b4acf
[Docs] Fix some broken links
2018-10-06 04:20:16 +08:00
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
c320d9394d
doc: Sync classref with current source
2018-09-11 00:18:21 +02:00
29f2571662
update class docs
2018-08-31 22:35:15 +02:00
2d0a55c86c
Clarify direction of input event propagation
2018-08-26 15:14:55 +02:00
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
23b7edb214
[DOCS] Updates to assorted class descriptions.
2018-08-17 14:55:19 -07:00
79ab43299a
Small doc formating changes and Linux cursor theme note
2018-08-05 04:07:04 -03:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
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
c6ed46891d
[docs] fix links in class docs
2018-05-17 00:15:30 +08:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
a88ee7d920
[Docs] fix typos
2018-03-29 12:46:21 +07: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
7154a96d3f
added docs on Control's drag and drop api
2018-02-26 15:54:08 -08:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
5e0821e867
Small fixes for the Control description in the docs.
2018-02-01 19:43:44 -02:00
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +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
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
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
524ee14054
Small fix for Control bindings
2018-01-13 09:40:42 +01:00
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
7251c5b582
Improve Control and Label documentation about mouse filtering
...
Fixes #9657 .
2018-01-09 17:40:19 +01:00
305ab94431
Document Control.mouse_filter and its constants.
2018-01-04 18:20:19 +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
15ada56d73
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
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
0e04316214
Merge pull request #12962 from SaracenOne/gui_focus_next_prev
...
Add manual overrides for focus_next and focus_previous
2017-11-17 15:03:05 -03:00
e4201734df
Add manual overrides for focus_next and focus_previous on controls similar to what can already be done with focus neighbours.
2017-11-16 09:45:52 +00: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
482e07af7e
Unify degree members and properties
2017-11-10 12:52:07 +01:00
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
b1f2c31a36
doc: Sync classref with current source
...
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
55ac818d9a
[DOCS] Write member, signals and constants in the Control class
...
I left the following properties and constants out:
- rect_clip_content, I think it should let me resize the node below the content's size, but even with the minimum size set to (0,0) Godot won't let me
- mouse_filter, grow_horizontal and grow_vertical, same issue, after testing I don't know when they're necessary, so can't document them.
- GROW_DIRECTION_BEGIN, GROW_DIRECTION_END, MOUSE_FILTER_STOP, MOUSE_FILTER_PASS, MOUSE_FILTER_IGNORE, constants that correspond to the member variables above
For the mouse_filter, I couldn't see what it does in 3.0 alpha 1. For the grow_direction, I can see they might change the size calculation when the node's size changes, but in practice, with containers, I couldn't see a difference. If you know when to use it, please tell me and I'll add them to the PR.
2017-10-02 08:34:11 +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
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
Rémi Verschelde
Hugo Locurcio
Aspin
Sean Heffernan
Tomasz Chabora
Ignacio Etcheverry
danboo
Pieter-Jan Briers
Kelly Thomas
LikeLakers2
Mel Collins
Chris Bradfield
Michael Alexsander Silva Dias
robojumper
Poommetee Ketson
indicainkwell
Juan Linietsky
letheed
Bojidar Marinov
PJB3005
Martin Capitanio
Saracen
Nathan