13f642d959
Replace XML codeblock spaces with tabs
2025-06-06 14:35:38 +02:00
cf3f02c550
Merge pull request #94143 from Mickeon/documentation-object-connect-to-signal-too-long-didn't-read
...
Move and simplify Object's `connect` description slightly
2025-04-09 18:11:59 -05:00
83dac9cdb8
Document Object.has_signal() in the Signal class reference
2024-10-02 16:36:19 +02:00
011954fea3
Refactor signal documentation to improve clarity
2024-09-23 22:58:06 +05:30
203d3be200
[Core] Add way to check if a signal has any connections
...
Added to `Object` and `Signal`
2024-09-20 16:39:09 +02:00
5b91040ba6
[Doc] Clarify is_null methods of Callable and Signal
2024-08-25 14:33:07 +02:00
824d4ee855
Move and simplify Object's connect description
2024-07-09 21:21:21 +02: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
04562662d3
Overhaul the top sections of the class reference (Core classes)
2023-05-19 07:04:48 +02: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
03ae8caea8
Fix incorrect description for Signal::get_connections
2023-02-03 17:28:17 +01:00
92e4b4e888
Update C# signal documentation and remove bind array
...
- Updates C# signal documentation and code examples to the new API in 4.0
- Replace all `nameof` usages with the exposed `StringName`
2023-01-23 16:45:37 +01:00
c868c9fc41
Fix warning in Signal Documentation
2022-11-24 11:34:32 +01:00
4534de065f
Tweak Signal Documentation
...
- Add missing Operator and leading description
- Avoid calling "Signal" an object or class.
- Add more details to `connect` and `disconnect`
2022-11-23 12:02:14 +01:00
a23f6d0aa6
Fill random docs
2022-11-22 17:59:45 +01:00
1f72f48361
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-09 22:00:19 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
dc4bf7f6e6
Add tutorial links to Signal's documentation
2022-04-08 08:25:45 -06: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
6772ebcea0
Move the docs for constructors and operators out of methods section
2021-10-29 12:34:57 -05:00
0abe464162
Merge pull request #52849 from KoBeWi/know_no_binds
2021-09-25 00:10:56 +02:00
7bf5fc709e
Remove binds from Signal.connect
2021-09-24 17:07:33 +02: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
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
4ca1e73ff9
doc: Sync classref with current source
...
And move GLTF docs to its module folder.
2021-03-18 16:37:43 +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
424cd00f8b
doc: Sync classref with current source + fixup some bindings
...
Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
a2d3ba3372
doc: Sync classref with current source
...
Fix wrong binding after #37111 .
2020-03-18 09:14:57 +01:00
e103f21a40
Add LOTS of missing docs
2020-03-13 16:35:03 +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
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00