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
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
528c4722d6
doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred
2019-06-27 14:43:37 +02:00
Rémi Verschelde
867dda1124
doc: Proofread and complete various nodes
...
All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.
Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-26 23:05:51 +02:00
Rémi Verschelde
a9cff880d6
doc: Document EncodedObjectAsID, expose its property
2019-06-26 10:50:45 +02:00
Randall Fulton
6843ad87a4
Add docstring for Object.set_deferred
2019-06-24 12:57:14 -05:00
Nathan Lovato
21a0dad58a
Improve the documentation of the Object class
...
I edited the main description to remove parentheses and split long sentences.
Closes #29382
Closes #29384
2019-06-03 19:10:59 +09:00
Rémi Verschelde
86f6d08923
doc: Sync classref with current source
2019-05-21 13:27:03 +02:00
Rémi Verschelde
defd960276
Merge pull request #27886 from LeonardMeagher2/obj_to_string
...
Allow overriding how scripted objects are converted to strings
2019-05-20 22:37:01 +02:00
Leonard Meagher
f7eb426e2e
Allow overriding how scripted objects are converted to strings
...
solves #26796
- ADD `String to_string()` method to Object which can be overriden by `String _to_string()` in scripts
- ADD `String to_string(r_valid)` method to ScriptInstance to allow langauges to control how scripted objects are converted to strings
- IMPLEMENT to_string for GDScriptInstance, VisualScriptInstance, and NativeScriptInstance
- ADD Documentation about `Object.to_string` and `Object._to_string`
- Changed `Variant::operator String` to use `obj->to_string()`
2019-05-03 15:06:05 -07:00
Rémi Verschelde
c991379b81
doc: Sync classref with current source
2019-04-30 14:23:59 +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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Rémi Verschelde
2e39e38c10
doc: Sync classref with current source
...
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
Davide Cristini
a98baad18f
Docs: Add mention to Object constructors in scripting languages
...
Fixes godotengine/godot-docs#1968 .
2018-12-13 20:23:36 +01:00
Rémi Verschelde
daa9092ed3
doc: Sync classref with current source
2018-11-20 09:34:45 +01:00
luz.paz
08bde5b2de
Misc. typos
...
Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
2018-09-12 21:39:17 -04:00
Rémi Verschelde
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
Fluffel
a164d593c0
[DOCS] get_indexed, tween
2018-08-11 08:48:37 -05:00
Juan Linietsky
d5bb6faac7
-Make sure that ProjectSettings are properly dumped when dumping docs.
...
-Documented all properties of project settings
Update documentation for ProjectSettings
2018-06-11 13:41:16 -03:00
Craigory V Coppola
0dd526e062
Docs update for several classes
...
Namely: Dictionary, GraphEdit, Object, TileMap, Script, ScollBar,
ScrollContainer and SplitContainer
2018-04-19 21:09:53 +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
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
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
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
Rémi Verschelde
e7701bb2de
doc: Rename "@Global Scope" to "@GlobalScope"
...
Spaces in filenames are evil.
2017-11-15 20:41:16 +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
Nathan Warden
09a1d01b74
[DOCS] Object
2017-11-08 22:18:07 -05:00
Andreas Haas
4c716f3623
[DOCS] Fix a few typos.
2017-10-14 12:45:49 +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