summaryrefslogtreecommitdiff
path: root/doc/classes/Dictionary.xml
AgeCommit message (Collapse)Author
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-12Clarify identical `hash()` return values due to collisionsHugo Locurcio
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-10-29Move the docs for constructors and operators out of methods sectionAaron Franke
2021-10-06doc: Update links to latest documentation after content reorganizationRémi Verschelde
2021-09-30Merge pull request #53076 from zacryol/dict-typo-fixMax Hilbrunner
Fix typo with example variable name in Dictionary docs
2021-09-30Fix doc for Dictionary.eraseHaoyu Qiu
2021-09-26Fix typo with example variable name in Dictionary docs, and fix error in C# ↵zacryol
example
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-09-17Allow comparing equality between builtin types and nullGeorge Marques
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-03-19class reference proofreadingPaul Joannon
2021-03-18doc: Sync classref with current sourceRémi Verschelde
And move GLTF docs to its module folder.
2021-01-04doc: Sync classref with current sourceRémi Verschelde
2020-12-28Rename empty() to is_empty()Marcel Admiraal
2020-11-14Improve the Dictionary class documentationHugo Locurcio
- 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-10doc: Sync classref to add operators after #43419Rémi Verschelde
2020-11-09Variant: Sync docs with new constructors, fixups after #43403Rémi Verschelde
Change DocData comparators for MethodDoc and ArgumentDoc to get a better ordering of constructors.
2020-11-01Port code examples to C# (D)HaSa1002
Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-10-01Link to demos from within the class referenceAaron Franke
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-06-12Document the `in` operator in String, Array and Dictionary classesHugo Locurcio
This also clarifies the `in` operator behavior in Object.
2020-06-10Mention ordering caveats for `Dictionary.hash()`Hugo Locurcio
See https://github.com/godotengine/godot/issues/27615.
2020-05-16Document that Dictionary is always passed as referenceHugo Locurcio
See #38792.
2020-04-19Correct the addition of a key and the duplication of a variable nameMarcel Admiraal
in Dictionary class documentation.
2020-04-12Improve the Dictionary class documentationHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/3376.
2020-04-02Clarify Dictionary duplicate params godotengine#37162Zak Grumbles
* Added additional clarification for the function of the 'deep' parameter in the Dictionary's `duplicate` method.
2020-03-18doc: Sync classref with current sourceRémi Verschelde
Fix wrong binding after #37111.
2020-03-09DocData: Fix serialization of Variant default valuesRémi Verschelde
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2020-02-22doc: Sync classref with apparent Variant return type changesRémi Verschelde
Part of those seem bogus, methods like Array.back()/front() should return a Variant and not void.
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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-23Remove unnecessary extra spaces before comments in code examples.Michael Alexsander
2020-01-23doc: Misc updates for AnimationNode* and othersRémi Verschelde
- 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-20Improve dictionary description Feniks
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.
2019-11-11Mention that `Dictionary.hash()` can be used for equality comparisonsHugo Locurcio
See #27615.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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-05-23Change "Return" to "Returns" where necessary in XML documentationSean Heffernan
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-04Document dictionary erase return valuelopho
2019-04-22Merge pull request #28125 from KoBeWi/code_true_codeRémi Verschelde
Consistently wrap booleans in [code]
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-17Consistently wrap booleans in [code]Tomasz Chabora
2019-04-05Merge pull request #27465 from ↵Rémi Verschelde
neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-03-29ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-14[DOCS] minor classref updatesChris Bradfield
2019-02-10added warnings about Dictionary element erasure while iterating over itEvgeny Savelyev
2018-11-20doc: Sync classref with current sourceRémi Verschelde
2018-11-19Added Python-like .get() method to Dictionary in GDScript #20488m
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-08-31DocData: Fix return type listed as "var" instead of "Variant"Rémi Verschelde