Commit Graph

852 Commits

Author SHA1 Message Date
Max Hilbrunner
124436d178 Merge pull request #11426 from charjr/destroy-vector2
Explicitly destroy Vector2
2025-11-05 14:56:34 +01:00
Max Hilbrunner
452a0e7c9f Merge pull request #11381 from Calinou/gdextension-file-libraries-relative-path
Document relative paths in `.gdextension` files being supported
2025-11-05 14:51:44 +01:00
Samuel Nicholas
9e754497d6 godot-cpp CMake documentation guideline conformance updates (#11376)
* cmake-updates

Documentation Guideline Conformance
- added sphinx reference name, matching the scons name
- fix admonition formatting
- use proper headings rather than topic::
- reflow due to change of indent.
- add code block language to fix highlighting
- fix bad formatting for bullet points
-  a couple of full stops, colons, and capitilsation
- added a link to the android documentation in the admonition

---------

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2025-11-05 14:51:14 +01:00
Hugo Locurcio
9420053a95 Document relative paths in .gdextension files being supported
- Mention support for comments in `.gdextension` files.
- List recommended import options for GDExtension icons.
2025-11-04 18:34:50 +01:00
Max Hilbrunner
a502dee2a9 Merge pull request #11372 from Calinou/gdscript-basics-function-parameter-defaults
Document function parameter defaults in GDScript reference
2025-10-31 18:43:47 +01:00
John
e24d1809ef Explicitly destroy Vector2 2025-10-29 17:29:34 +00:00
Max Hilbrunner
f908cdcb72 Merge pull request #11369 from Ivorforce/godot-cpp-intro-mobile
Remove mentions of mobile platforms from godot-cpp "Getting started" document
2025-10-22 21:11:31 +02:00
Max Hilbrunner
f762543357 Merge pull request #11389 from dsnopek/gdextension-c-extern
Add `extern` to global struct variables in GDExtension C example
2025-10-22 21:09:14 +02:00
Max Hilbrunner
24c7dba4b9 Merge pull request #11390 from dsnopek/gdextension-c-funcptr-cast
Always cast function pointers in GDExtension C example
2025-10-22 14:17:15 +02:00
David Snopek
d807d2b54c Always cast function pointers in GDExtension C example 2025-10-19 09:11:21 -05:00
David Snopek
6f371fa60e Add extern to global struct variables in GDExtension C example 2025-10-19 06:35:33 -05:00
John
8f4277b9f2 Remove erroneous include guard
The tail end of an include guard is provided
within the defs.h code blocks,
however #pragma once is used at the top instead.
2025-10-18 20:51:18 +01:00
Hugo Locurcio
2481589819 Document function parameter defaults in GDScript reference
This also fixes some reStructuredText syntax issues.
2025-10-14 23:40:37 +02:00
Samuel Nicholas
b61cd5d935 Update Working with CMake GDExtension documentation (#11370)
- Respect the 80 column rule.
- Be more explicit in code blocks.
- Re-arrange for faster grokking.
- Remove half-made tested toolchain section.
- Fix /s/mutially inclusive/mutially exclusive.
- Remove old warning.
- Update examples.

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
Co-authored-by: Lukas Tenbrink <lukas.tenbrink@gmail.com>
2025-10-14 16:51:55 +02:00
Lukas Tenbrink
bf1841e7d1 Remove mentions of mobile platforms from godot-cpp "Getting started" document. 2025-10-13 00:38:54 +02:00
Max Hilbrunner
f6b40a054e Merge pull request #11352 from Calinou/remove-old-version-references
Remove old Godot version references to simplify documentation
2025-10-11 12:45:38 +02:00
Max Hilbrunner
4dac16745f Merge pull request #11344 from Ivorforce/godot-cpp-custom-bindings
Move godot-cpp custom API file information from "Getting Started" to build system information
2025-10-09 13:36:08 +02:00
Max Hilbrunner
424d523d35 Merge pull request #11348 from Calinou/csharp-basics-net-9
Update C# basics for .NET 9
2025-10-09 13:26:06 +02:00
notroid5
cf795af4f8 Update static_typing.rst
Fixed missing new line
2025-10-08 11:39:42 +02:00
Hugo Locurcio
b3cbe5f777 Remove old Godot version references to simplify documentation
This follows the documentation writing guidelines, specifically
the "When to refer to a specific Godot version" section.

This also removes warning blocks for a known issue that was resolved in Godot 4.5.
2025-10-07 19:01:12 +02:00
Hugo Locurcio
36455d91fa Update C# basics for Godot 4.5 2025-10-07 17:37:36 +02:00
Lukas Tenbrink
88604e597b Move godot-cpp custom bindings information to the 'build system' instructions from the intro doc, because most people won't need it for their first project. 2025-10-05 13:30:33 +02:00
Max Hilbrunner
0747a890c5 Merge pull request #10919 from Ivorforce/godot-cpp-build-system
Add "Build System" section to godot-cpp docs.
2025-10-02 16:11:31 +02:00
Max Hilbrunner
3521a55f51 Merge pull request #11299 from mihe/logger-thread-safety
Mention importance of thread-safety in `Logger` example
2025-09-27 02:00:10 +02:00
Max Hilbrunner
bc2e347f50 Merge pull request #11302 from Calinou/gdscript-static-typing-global-scope-methods
Document global scope methods in Static typing in GDScript
2025-09-22 17:19:05 +02:00
peachey2k2
e8e6a57c2b GDExtension: Fix typo in "GDExtension documentation system" (#11310)
* GDExtension: Fix typo in "GDExtension documentation system"

* Apply suggestions from code review

---------

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
2025-09-20 09:40:28 -04:00
Mikael Hermansson
b9ca08304f Mention importance of thread-safety in Logger example 2025-09-18 17:40:08 +02:00
Hugo Locurcio
f3fd393817 Document global scope methods in Static typing in GDScript 2025-09-18 00:43:48 +02:00
Hugo Locurcio
3b11c2f5ab Fix code block highlighting in Logging
Some blocks were using syntax highlighting when they shouldn't.
2025-09-14 22:46:50 +02:00
Hugo Locurcio
7b98025f2e Add logging documentation
This also covers how to create custom loggers.

- Remove notice on Windows 10 requirement for `print_rich()` in Output panel,
  since Godot requires Windows 10 as of 4.5.
2025-09-14 02:51:27 +02:00
Lukas Tenbrink
757d1f7d01 Add "Build System" section to godot-cpp docs (SCons and CMake). 2025-09-09 16:24:01 +02:00
Hugo Locurcio
0b03cc70ed Clarify assignment operator in typed array/dictionary documentation 2025-08-26 18:45:48 +02:00
Markus Kauppila
81b7f5233a Update creating_script_templates.rst 2025-08-16 13:38:42 +03:00
Muller-Castro
e7f954bf7c Add tabs to SConstruct snippet 2025-08-04 04:43:47 -03:00
AtelierFerrofell
310494375b Update c_sharp_exports.rst to remove note about typed dictionary support
That note appears to be obsolete
2025-08-01 19:35:32 -07:00
AtelierFerrofell
a531c1b7d5 Update resources.rst to remove stray whitespace
Whitespace on line 216 was causing code to merge into the tab name
2025-08-01 15:56:18 -07:00
Danil Alexeev
3946ede7aa Replace remaining uses of shorthand codeblock syntax, add CI check 2025-07-25 16:20:16 -04:00
Leandro (cerberus1746) Benedet Garcia
97f5aad069 Added tags and updated doc 2025-07-22 12:29:23 -03:00
Matthew
ff29de0d89 Merge pull request #9980 from HolonProduction/editable-clearup
Clearify behaviour of `@export` in combination with setters
2025-07-18 21:20:31 -04:00
Matthew
29e83d3863 Merge pull request #11059 from Zshandi/patch-2
Update resources.rst to make inner class note more clear
2025-07-18 21:14:17 -04:00
Matthew
3f65fd4614 Merge pull request #10888 from Calinou/running-code-in-the-editor-static-context
Clarify rules around which scripts require `@tool` in Running code in the editor
2025-07-18 07:54:13 -04:00
Matthew
768aa536ca Merge pull request #10920 from Athenr/master
Clarify UTF encoding between C# strings and Godot Strings
2025-07-18 07:50:20 -04:00
Ayush Raj
2cbf133533 fixed issue 11090 2025-07-07 20:48:57 +00:00
Dipl.-Ing. Dr. Markus Weninger, BSc
15912feec0 Update static_typing.rst
The documentations said it shows the same callback two times, one time with dynamic typing and one time with type hints. In reality, two different callbacks were shown. This has been fixed.
2025-06-28 21:25:45 +02:00
Matthew
ba34190d15 Merge pull request #11029 from dalexeev/gds-abstract-and-variadic-funcs
GDScript: Document abstract and variadic functions
2025-06-28 12:49:49 -04:00
Matthew
7e591554a2 Merge pull request #10823 from Calinou/gdscript-exports-tool-button-icon
Document `@export_tool_button` icon parameter in GDScript exports
2025-06-27 14:31:22 -04:00
Zshandi Krahn
6e9342991d Update resources.rst to make inner class note more clear
The term "subclass" is often used as a synonym for "child class", so using it here to refer to an inner class is just confusing, even with the "i.e. an inner class" part. The GDScript Reference page simply uses the term "inner class" and never refers to them as "subclass", so this is also consistent with that.
2025-06-26 23:42:45 -07:00
Danil Alexeev
7a7ac7dc2d GDScript: Document abstract and variadic functions 2025-06-24 10:25:49 +03:00
A Thousand Ships
92cd36b50e Various grammar and spelling fixes 2025-06-23 16:37:26 +02:00
HolonProduction
b26724f1b4 Clearify behaviour of @export in combination with setters 2025-06-16 23:47:57 +02:00