PouleyKetchoupp
52e799b6d4
Code format for true/false/null to make documentation consistent
2019-11-02 12:14:15 +01:00
luz.paz
91ecd7b6a6
Fix misc. source comment typos
...
Found using `codespell -q 3 -S ./thirdparty,*.po -L ang,ba,cas,dof,doubleclick,fave,hist,leapyear,lod,nd,numer,ois,paket,seeked,sinc,switchs,te,uint -D ~/Projects/codespell/codespell_lib/data/dictionary.txt `
2019-09-19 14:36:52 -04:00
Rémi Verschelde
65d61d0360
doc: Sync classref with current source
2019-08-29 15:33:52 +02:00
Rémi Verschelde
1349e0e585
doc: Sync classref with current source
...
Fix wrong hyperlinks in Control and Tree.
2019-08-22 14:49:30 +02:00
Rémi Verschelde
592909db16
doc: Sync classref with current source
2019-08-13 12:35:50 +02:00
Tomasz Chabora
2dbc817b93
Complete the Control class documentation
2019-08-07 15:31:47 +02:00
Rémi Verschelde
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
Rémi Verschelde
542489a866
DocData: Re-expose parametric setters and getters
...
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.
For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-07-04 14:08:16 +02:00
Rémi Verschelde
a78373ddc2
doc: Remove null default values that can't be determined
...
Applying #30187 .
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
Rémi Verschelde
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
Aspin
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
Sean Heffernan
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
Rémi Verschelde
86f6d08923
doc: Sync classref with current source
2019-05-21 13:27:03 +02:00
Rémi Verschelde
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Tomasz Chabora
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
Rémi Verschelde
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
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Ignacio Etcheverry
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
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