Commit Graph

107 Commits

Author SHA1 Message Date
31
7b588dca1f Update c_sharp_differences.rst ToSignal example 2024-01-15 10:26:16 -06:00
Hugo Locurcio
95fb178429 Add support for user-provided comments with Giscus
This allows users to leave comments on pages that don't have
`:allow_comments: False` somewhere in the page's source.
Both manual and class reference pages can receive comments.
Index pages cannot have comments, as discussion should occur on "leaf" pages.

GitHub Discussions is used as a backend on the same repository. This means
that Discussions *must* be enabled on godotengine/godot-docs before this
commit is merged to `master`. Users can choose to use the "Custom" watch
mode if they don't want to get notifications for discussion updates,
but still get notifications for issue and pull request updates.

User comments are intended to be used for the following purposes:

- Add a clarification or correct something in the documentation,
  without having to open a pull request. Contributors are encouraged to
  take a look at discussions from time to time, and see if there's information
  worth incorporating in the pages themselves. Don't forget to reply to
  the comment when doing so :)
- Mention a workaround for a common issue.
- Link to useful third-party resources that are relevant to the current page,
  such as tutorials or add-ons.

User comments should *not* be used for technical support. Other community
platforms should be used for that.

Page-to-discussion matching is done using the `pagename` Sphinx variable,
which is independent of the Godot version and documentation language.
Being independent of the Godot version allows keeping old comments
when the Godot version changes, while also allowing users from `/stable`
and `/4.1` to "see" each other in discussions.

See https://giscus.app for more information.
2024-01-11 17:51:53 +01:00
Hugo Locurcio
8a52cac55b Update documentation changelog for 4.2 2023-12-03 18:15:15 +01:00
Paul Joannon
eb13caffd7 Change the note about disconnecting C# signals 2023-11-29 17:46:19 +01:00
Rémi Verschelde
ee401703f0 Remove UWP mentions as the platform port was removed in 4.2 2023-11-16 13:03:31 +01:00
Max Hilbrunner
9e6534f539 Merge pull request #8440 from tetrapod00/patch-2
c_sharp_exports.rst: use uint for layers; update casing to C# convention
2023-11-10 22:25:40 +01:00
Yuri Sizov
cd92be066d Update references to private class methods across the docs 2023-11-10 16:06:36 +01:00
tetrapod
5e16b58e79 Use uint for layers in c_sharp_exports.rst 2023-11-09 13:38:08 -08:00
Hugo Locurcio
8f963d91e8 Improve GDExtension documentation
- Mention additional language bindings that support 4.x (already listed
  on the FAQ and List of features pages).
- Document compatibility issues with double-precision builds.
- Remove `-j4` flag from example as SCons uses most CPU cores
  automatically by default in godot-cpp now.
2023-11-07 14:42:44 +01:00
Max Hilbrunner
1e2867c976 Merge pull request #8341 from raulsntos/dotnet/diagnostics-update
Update C# diagnostic documentation
2023-10-27 21:32:17 +02:00
Raul Santos
52ac488079 C#: Add documentation for GD0107 2023-10-27 16:33:14 +02:00
Susheel Thapa
a98b5a5545 fix typo in multiple files (#8291)
* fix typo in multiple files

* Updated as per suggestions
2023-10-20 11:34:46 +02:00
Raul Santos
b63001f753 Fix C# diagnostic messages to match 4.2 2023-10-18 14:05:14 +02:00
Raul Santos
f8ed631531 Update the state of C#/.NET support as of 4.2 beta 1 2023-10-12 20:26:32 +02:00
Raul Santos
084f18b176 C#: Update images of the Build button 2023-10-06 00:47:40 +02:00
Max Hilbrunner
44136776a9 Merge pull request #8142 from YuriSizov/csharp-support-update
Update the state of C#/.NET support as of 4.2
2023-10-03 23:55:33 +02:00
Raul Santos
4266830497 Update C# differences for 4.2 2023-10-03 18:08:18 +02:00
Yuri Sizov
ac728e8dd2 Update the state of C#/.NET support as of 4.2 2023-10-03 18:03:52 +02:00
Ershn
b3615711ff Make some clarifications/fixes in the C# docs 2023-09-25 09:14:16 +09:00
Luna
0fe7ff833e Fixed typos in several doc files (#8002)
* Fixed typos in
- c_sharp_differences.rst
- debugger_panel.rst
- gdextension_cpp_example.rst
- gui_using_fonts.rst
- openxr_hand_tracking.rst
- overview_of_debugging_tools.rst
- setting_up_xr.rst
- shading_language.rst
- the_profiler.rst
- your_second_3d_shader.rst

* Update tutorials/shaders/shader_reference/shading_language.rst

Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>

* PR Feedback

---------

Co-authored-by: Luna <2650849-Lunalicious@users.noreply.gitlab.com>
Co-authored-by: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com>
2023-09-25 00:41:33 +02:00
Jaime Crespo
22f25b6773 C#: Document new Asinh, Acosh and Atanh functions in Mathf
Document on the list of C# api differences the newly exposed

* Mathf.Asinh()
* Mathf.Acosh()
* Mathf.Atanh()

Followup to godotengine/godot#81229
2023-09-23 19:42:24 +02:00
31
7eccc4e94b Remove outdated VS setup and 2019 support info
Removes VS 2019 from the list of supported IDEs. It doesn't support .NET SDK 6.0 and can't build Godot projects.

Removes mention of the VS extension. It only applies to 3.x projects and debugging is done with ordinary debugging tools after the move to .NET in 4.x.
2023-09-19 10:49:51 -07:00
Corey
dbd4468aae Update c_sharp_basics.rst
* Fix incorrect file name with regards to adding the `program` parameter.
2023-09-17 13:41:38 -07:00
Raul Santos
44029d167d Document C# diagnostics 2023-08-10 16:37:42 +02:00
Max Hilbrunner
87dbe4a98f Merge pull request #7586 from br1trs/update_VS_Workloads 2023-07-19 21:33:31 +02:00
Max Hilbrunner
87a7b5e3f7 Merge pull request #7612 from raulsntos/dotnet/diff-4.1 2023-07-18 15:06:42 +02:00
Max Hilbrunner
fcc07e1eab Merge pull request #7525 from RedworkDE/net-version-defines 2023-07-18 13:45:12 +02:00
Max Hilbrunner
c26440a0b0 Merge pull request #7626 from bbrainstormer/master 2023-07-18 13:26:28 +02:00
CactiChameleon9
cf5222b129 Fix mention of Godot3's or_lesser for export_range 2023-07-08 06:34:20 +01:00
bbrainstormer
2af093e679 Remove exprange info
PropertyHint.ExpRange was removed in godot 3.4.  This commit removes the outdated information from the wiki.
2023-07-07 20:54:10 -04:00
Raul Santos
13ab995921 Update C# differences list for 4.1 2023-07-05 11:38:54 +02:00
br1trs
732cb27372 Update c_sharp_basics.rst 2023-06-30 17:59:03 -06:00
Hugo Locurcio
1e411aa125 Document C# currently not being supported on Android, iOS and Web 2023-06-23 23:14:56 +02:00
RedworkDE
31ac1bc64d C#: Document new version defines and remove mentions of old defines 2023-06-16 10:25:39 +02:00
Raul Santos
27e7f8433c Add page about using global classes in C# (#6740)
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-06-06 11:13:49 +02:00
RedStainedInk
a434971e4f Updating the instructions for C# debugging in Visual Studio Code (#6977)
* Updating the instructions for Visual Studio Code

Edited the instructions needed to make Visual Studio Code debugging work with Godot 4 - .net. Explained the situation with the not yet updated Godot c# extension for Visual Studio Code.

---------

Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
Co-authored-by: Raul Santos <raulsntos@gmail.com>
2023-03-22 11:26:22 +01:00
Ivan Shakhov
c3869d986a update the profiling C# code section of the doc for Godot 4 (#7025)
* update the profiling C# code section of the doc for Godot 4

---------

Co-authored-by: Raul Santos <raulsntos@gmail.com>
Co-authored-by: Max Hilbrunner <mhilbrunner@users.noreply.github.com>
2023-03-22 11:01:59 +01:00
Yuri Sizov
d91b6d4058 Merge pull request #6820 from hughowens/UpdateTutorialTextMonoToDotnet
Update references to "Mono" menu item to "Dotnet"
2023-02-26 16:24:33 +01:00
Max Hilbrunner
3592c269ac Merge pull request #6792 from RedworkDE/compiling-with-mono-net
Update the `Compiling with Mono` page
2023-02-26 10:06:15 +01:00
hughowens
e5f3f1f928 Update references to "Mono" menu item to "Dotnet"
Update references to "Mono" menu item to "Dotnet" in the text of the C Sharp Basics tutorial to match the actual menus as of Godot 4 RC5
2023-02-25 14:27:05 -08:00
Raul Santos
4fc468e2e9 Apply suggestions from code review
Co-authored-by: RedworkDE <10944644+RedworkDE@users.noreply.github.com>
2023-02-21 19:39:29 +01:00
RedworkDE
4d78c82027 Rename page mono->dotnet, Doc build_assemblies args, Note about mono, Reviews, Fixes 2023-02-20 12:28:56 +01:00
Raul Santos
7f35d9b38e Update tutorials/scripting/c_sharp/c_sharp_collections.rst
Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
2023-02-13 21:24:40 +01:00
Raul Santos
c403465613 Add C# collections documentation page
- Move documentation of the Godot C# collection types to a dedicated page.
- Document the differences between .NET collections and Godot collections.
- Help users choose which type of collection to use in C#.
2023-02-13 21:24:39 +01:00
Max Hilbrunner
0464ade11c Merge pull request #6761 from Piralein/warnings
Update Invalid References
2023-02-12 18:34:53 +01:00
Raul Santos
62266a1634 Update C# exports documentation (#6746)
* Update C# exports documentation

- Node exports are supported in 4.0.
- Add documentation about exporting enums (and flag enums).
- Add more documentation about exporting collections.
- Changes to follow our style guide more closely.

---------

Co-authored-by: Hana <48352564+Piralein@users.noreply.github.com>
2023-02-12 18:31:38 +01:00
Hana
64476d96b4 update references 2023-02-10 19:13:03 +01:00
Raul Santos
5010fa0d17 Add missing differences to C# documentation (#6739)
* Add missing differences to C# documentation

- Add `NodePath` section.
- Add `RID` section.
- Update `Transform2D` section.
- Add `Transform3D` section.
- Add `Rect2i` section.
- Add `AABB` section.
- Add `Projection` section.

---------

Co-authored-by: Paul Joannon <437025+paulloz@users.noreply.github.com>
2023-02-08 12:44:20 +01:00
31
8a9729d900 Add C# type test example (pattern matching) (#6732)
* Add C# type test example (pattern matching)
* Connect section to "is" section, put "advanced" note back
2023-02-05 16:22:07 +03:00
31
e155194384 C#: Replace "falsy" with "false" in C# "is" doc (#6733) 2023-02-05 16:08:39 +03:00