5325de4e6b
Improve the Dictionary class documentation
...
- Mention Lua-style syntax.
- Make the code samples self-contained.
- Mention caveat with `const` (also in Array).
- Clarify the description of `size()`.
This closes https://github.com/godotengine/godot-docs/issues/4272 .
2020-11-14 22:05:53 +01:00
64e893deac
doc: Sync classref to add operators after #43419
2020-11-10 15:00:50 +01:00
0f249f5c0a
Variant: Sync docs with new constructors, fixups after #43403
...
Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
2020-11-09 23:39:53 +01:00
8fb113bb4c
Port code examples to C# (D)
...
Includes:
* Decal
* Dictionary
* Directory
* DisplayServer
* DTLSServer
* DynamicFont
* EditorImportPlugin
* EditorPlugin
* EditorScenePostImport
* EditorScript
* EditorSettings
* EditorTranslationParserPlugin
* Engine
* Expression
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-11-01 09:05:17 +01:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
7f01f68226
Document the `in` operator in String, Array and Dictionary classes
...
This also clarifies the `in` operator behavior in Object.
2020-06-12 19:22:35 +02:00
77b89263dd
Mention ordering caveats for `Dictionary.hash()`
...
See https://github.com/godotengine/godot/issues/27615 .
2020-06-10 09:33:43 +02:00
675fea1648
Document that Dictionary is always passed as reference
...
See #38792 .
2020-05-16 23:52:40 +02:00
4d41535fa3
Correct the addition of a key and the duplication of a variable name
...
in Dictionary class documentation.
2020-04-19 09:52:54 +01:00
88da90f2bf
Improve the Dictionary class documentation
...
This closes https://github.com/godotengine/godot-docs/issues/3376 .
2020-04-12 22:48:02 +02:00
469b7c948f
Clarify Dictionary duplicate params godotengine#37162
...
* Added additional clarification for the function of the 'deep'
parameter in the Dictionary's `duplicate` method.
2020-04-02 10:02:02 -05:00
a2d3ba3372
doc: Sync classref with current source
...
Fix wrong binding after #37111 .
2020-03-18 09:14:57 +01:00
788765709d
DocData: Fix serialization of Variant default values
...
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2020-03-09 10:52:44 +01:00
048f4f8305
doc: Sync classref with apparent Variant return type changes
...
Part of those seem bogus, methods like Array.back()/front()
should return a Variant and not void.
2020-02-22 15:16:32 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
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
c4745c96d7
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 14:41:49 -03:00
ba177ccaec
doc: Misc updates for AnimationNode* and others
...
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
* Make `AnimationNodeTransition.input_<number>` properties internal
so that they don't appear in the docs. They still appear in the
inspector based on the actual number of inputs requested.
* Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
particles in `ParticlesMaterial`, and thus only relevant for
`CPUParticles3D`.
2020-01-23 12:37:33 +01:00
6e24933115
Improve dictionary description
...
I improved dictionary description to ad some real life examples and expand on it a little bit so person who never seen dictionary can understand it better seeing them for a first time here.
I also added note about the way to compare dictionaries as it can catch people of guard because common assumption is that it works the same as comparing Arrays when it does not.
2020-01-20 20:36:59 +00:00
ecd572073c
Mention that `Dictionary.hash()` can be used for equality comparisons
...
See #27615 .
2019-11-11 14:18:11 +01: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
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
5ce9bfcb4f
Document dictionary erase return value
2019-05-04 21:10:18 +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
454b701e76
[DOCS] minor classref updates
2019-03-14 11:36:12 -07:00
5594b08e90
added warnings about Dictionary element erasure while iterating over it
2019-02-10 23:28:22 +03:00
daa9092ed3
doc: Sync classref with current source
2018-11-20 09:34:45 +01:00
bf1867aaab
Added Python-like .get() method to Dictionary in GDScript #20488
...
Added .get() method to Dictionary class in GDScript to return the value if the key exists, or return Null if the key does not exist.
2018-11-19 14:03:13 -05:00
f92b87e5f8
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:41:14 +02:00
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
0dd526e062
Docs update for several classes
...
Namely: Dictionary, GraphEdit, Object, TileMap, Script, ScollBar,
ScrollContainer and SplitContainer
2018-04-19 21:09:53 +02:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02: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
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +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
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
abf20709af
doc: Sync classref with current source
2017-12-18 08:13:58 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01: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
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
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
Hugo Locurcio
Rémi Verschelde
HaSa1002
Aaron Franke
Marcel Admiraal
Zak Grumbles
clayjohn
Michael Alexsander
Feniks
Sean Heffernan
lopho
Tomasz Chabora
Ignacio Etcheverry
Chris Bradfield
Evgeny Savelyev
m
Craigory V Coppola
Juan Linietsky