Commit Graph

96 Commits

Author SHA1 Message Date
0c2296fb1b Fix C# boolean "Prints" comments in documentation 2024-11-11 21:19:34 +01:00
a7f6ec0e4c Add a sort method to Dictionary and HashMap 2024-10-02 14:26:33 -07:00
cc9f2b58a0 Bind Array get and set functions 2024-09-26 13:00:17 -07:00
9853a69144 Implement typed dictionaries 2024-09-04 10:27:26 -05:00
7cf9ed5f65 Fix several typos in the documentation 2024-08-02 08:42:20 +08:00
e651421905 [TextServer, GDExtension] Fix building text servers as GDExtension, expose new/changed low-level methods to GDExtension API. 2024-06-12 19:30:19 +03:00
c83718624f Update links to outdated asset library demos
Update links to outdated asset library demos

Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com>
2024-04-07 16:59:43 +02:00
eb0a624902 Allow returning Dictionary after merging 2024-03-06 14:49:35 +01:00
437586bf31 Add a get_or_add method to Dictionary 2023-12-06 11:43:58 -06:00
0396e12a47 Add an example for Dictionary.merge(), mention lack of recursion 2023-10-31 10:16:11 +01:00
2857b91385 Fix many typos in documentation 2023-07-19 19:56:06 +07:00
81064cc239 Doctool: Remove version attribute from XML header
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
346f1ab86b Bump version to 4.2-dev
Keep on waitin'
2023-07-05 22:07:03 +02:00
6723b4e8c3 C#: Fix dictionary key lookup documentation
The method to check if a key exists in the dictionary is called `ContainsKey`.
2023-06-02 11:13:03 +02:00
04562662d3 Overhaul the top sections of the class reference (Core classes) 2023-05-19 07:04:48 +02:00
d2b1d6e69b Remove outdated note about const in Dictionary and Array docs 2023-03-08 12:13:17 -03:00
1c1524a651 Bump version to 4.1-dev
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
7eb8325180 Fix C# examples in documentation
- Fix documentation after C# renames.
- Add missing `partial` in C# class declarations.
- Change `delta` parameter type to `double` in C#.
- Ensure parameters match base declaration.
- Use `$` string interpolation in C#.
- Fix invalid or outdated C# code.
- Changed some examples to follow our style guide more closely.
2023-01-31 19:04:07 +01:00
5909f9f075 GDScript: Fix issues with typed arrays 2023-01-31 11:54:41 +02:00
312011fade Fix various typos with codespell
And include #72377.

Co-authored-by: Wiktor Kocielski <withaust@gmail.com>
2023-01-30 14:22:47 +01:00
abe6d67232 GDScript: Fix test for read-only state of constants 2023-01-27 05:28:08 +02:00
b004f8180e GDScript: Allow constant expressions in annotations 2023-01-25 18:43:56 +03:00
346efd29e0 Fix typos with codespell 2022-12-15 12:24:08 +01:00
b77f93516e Overhaul Dictionary Documentation 2022-12-05 17:17:53 +01:00
f7c611ab71 Style: Misc docs and comment style and language fixes
- Removed empty paragraphs in XML.
- Consistently use bold style for "Example:", on a new line.
- Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`).
- Fix invalid usage of backticks for inline code in BBCode.
- Fix some American/British English spelling inconsistencies.
- Other minor fixes spotted along the way, including typo fixes with codespell.
- Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-02 19:01:18 +01:00
1b7aee3c8d Fill random docs 2022-10-07 20:10:18 +02:00
ff23defaf8 Fix typos in Dictionary.xml 2022-09-06 13:38:40 +03:00
cc424bcb18 Add Dictionary.find_key() 2022-08-16 13:48:59 +02:00
d32803fdd6 [doc] Use "param" instead of "code" to refer to parameters (7) 2022-08-12 13:19:48 -04:00
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
83421cd06f Merge pull request #59883 from KoBeWi/merge_this 2022-06-06 23:38:29 +02:00
a0915e6dee Add Dictionary.merge() 2022-05-31 21:05:56 +02:00
55b63eceaa Fix class name : change "string" to "String"
Change case of "s" letter : "string" does not compile but "String" does (for gdScript)
2022-05-29 00:40:56 +02:00
32f2c47356 Remove generating of null comparison operators from documentation 2022-03-14 22:35:23 +03:00
b68dd2e189 Add an XML schema for documentation
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-15 00:03:31 +01:00
08541fe11d Clarify identical hash() return values due to collisions 2022-02-12 22:21:37 +01:00
6c1bd4d227 Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 13:02:21 +01:00
6772ebcea0 Move the docs for constructors and operators out of methods section 2021-10-29 12:34:57 -05:00
862994a8ef doc: Update links to latest documentation after content reorganization 2021-10-06 13:48:48 +02:00
770bd61767 Merge pull request #53076 from zacryol/dict-typo-fix
Fix typo with example variable name in Dictionary docs
2021-09-30 20:19:05 +02:00
1e0fe9f817 Fix doc for Dictionary.erase 2021-09-30 01:18:47 +08:00
9359bee75c Fix typo with example variable name in Dictionary docs, and fix error in C# example 2021-09-26 11:16:55 -06:00
d54f2ad7ca Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05:00
455e142d37 Allow comparing equality between builtin types and null 2021-09-17 12:33:52 -03:00
7adf4cc9b5 doc: Use self-closing tags for return and argument
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-07-30 15:29:52 +02:00
8455e901f3 class reference proofreading 2021-03-19 13:21:20 +01:00
4ca1e73ff9 doc: Sync classref with current source
And move GLTF docs to its module folder.
2021-03-18 16:37:43 +01:00
215d18814e doc: Sync classref with current source 2021-01-04 14:33:44 +01:00
5b937d493f Rename empty() to is_empty() 2020-12-28 10:39:56 +00:00
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