b087538119
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-03-16 23:01:02 +01:00
0ffacff998
[3.x] Add option to make selection unique
2022-03-14 09:48:09 +01:00
986b99ed5c
Mention that modifying text erases BBCode stacks
...
(cherry picked from commit 3f0e9da5a4
2022-01-19 16:01:04 +01:00
c6a9a384a0
Merge pull request #55783 from timothyqiu/broken-doc-link
...
[3.x] Fix broken links in Class Reference
2021-12-10 15:51:17 +01:00
b1153f8829
Fix broken links in Class Reference
2021-12-10 21:07:21 +08:00
eac0d90c39
Merge pull request #55560 from pycbouh/docs-overridden-cross-linked-3.x
...
[3.x] Make overridden properties link to parent definition
2021-12-10 12:42:09 +01:00
1cf6d21f69
Make overridden properties link to parent definition
...
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-03 17:48:49 +03:00
ebd8101546
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 22:48:17 +03:00
3ac2999f22
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:22:47 +01:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
2401f1cf65
Add warnings to methods that give access to internal nodes
2021-10-10 23:10:07 +03:00
03af0f3e94
Add note to `RichTextLabel`
...
(cherry picked from commit 4a0cadd4ed
2021-09-21 17:15:01 +02:00
622f0b7d38
Document that most emoji won't display correctly on Windows
2021-09-15 18:52:21 +02:00
632844e464
Merge pull request #51320 from pycbouh/docs-extract-theme-items-3.x
...
[3.x] Add theme item descriptions to the online documentation
2021-08-13 22:39:09 +02:00
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02:00
fcbe5a3fde
Add theme item descriptions to the online documentation
2021-08-06 18:20:51 +03:00
f5836b40d4
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.
(cherry picked from commit 7adf4cc9b5
2021-08-03 10:20:19 +02:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
8651838268
doc: Fixup RichTextLabel bbcode_enabled note
2021-02-19 00:04:32 +01:00
72aef9d67e
Add information on bb code enabled
2021-02-18 23:46:33 +01:00
d73281a350
Keep RichTextLabel visible character properties in sync
...
The RichTextLabel class is inconsistent in how it updates the
visible_characters and percent_visible properties when either is changed.
To keep both properties consistent, update percent_visible when setting the
visible_characters property.
For both properties, when setting one, notify change for the other.
Docs updated for member set_visible_characters on RichTextLabel class.
(cherry picked from commit 463e2002ab
2021-01-15 16:49:46 +01:00
e2ff3ab88f
Document RichTextLabel not supporting entangled BBCode tags
...
See #44634 .
(cherry picked from commit 3b6612e48e
2020-12-30 09:56:17 +01:00
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
2020-10-19 16:10:01 +02:00
f568413e8d
Document `RichTextLabel.append_bbcode()` not closing previously open tags
...
This closes #42216 .
(cherry picked from commit 3e1457f517
2020-09-24 14:43:11 +02:00
13175b6387
Document limitations related to centering text with RichTextLabel
...
This is a relatively common question on various community channels.
(cherry picked from commit 95c2e43095
2020-08-21 02:28:18 +02:00
8fd861ab11
doc: Sync classref with current source
2020-06-22 13:24:11 +02:00
b3af0b2a39
Option in RichTextLabel for height to fit content
...
(cherry picked from commit ad8081216c
2020-06-19 16:17:27 +02:00
3739f03d98
Add LOTS of missing docs
...
(cherry picked from commit e103f21a40
2020-03-13 17:26:30 +01:00
4cee1cda5e
Merge pull request #35589 from akien-mga/doc-drop-category-property
...
doc: Drop unused 'category' property from header
2020-01-26 16:34:13 +01:00
09ced94dd4
doc: Do not expose Variant::NIL as a type in the class reference
...
Fix signals Variant arguments incorrectly listed as Nil.
Fixes #12520 .
2020-01-26 16:08:11 +01:00
2d20fc39aa
doc: Drop unused 'category' property from header
...
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-26 16:02:39 +01:00
5fc0a068d0
Rewording RichTextLabel::remove_line documentation
2020-01-07 08:29:10 +08:00
3deb209105
Completes the RichTextLabel documentation
2020-01-06 13:41:39 +08:00
abbff65dc8
Mention that bbcode_text += string is a bad idea
2019-12-21 10:45:26 +01:00
aa0fa6b14f
doc: Sync classref with current source
2019-10-26 16:40:41 +02:00
9f8ffd4146
Support for resized images in RichTextLabel
...
BBCode Tag:
[img=<width>x<height>]{path}[/img]
2019-10-16 12:00:15 +02:00
a7ac8ec876
doc: Fix parsing of self-closing XML tags
...
Follow-up to #31925 , `<member />` tags just before `</members>` would cause
a parsing issue, and we'd never notice that we're no longer parsing members.
Also added space before closing `/>`.
2019-09-24 13:34:05 +02:00
2f52d73c21
Merge pull request #31925 from bojidar-bg/31855-overriden-properties-docs
...
Add overriden properties to the documentation
2019-09-24 11:53:43 +02:00
4f294b958f
doc: Sync classref with current source
...
Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:52:06 +02:00
b397bcf4a1
Run doctool after overridden properties changes
2019-09-04 15:26:08 +03:00
9580c2b13e
TreeItem: Rename new button disable method to set_button_disabled
...
Follow-up to #30408 .
Also sync classref with current source.
2019-07-09 09:17:42 +02:00
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
c6cea6e9b3
doc: Add default values to all properties
...
Thanks to @bojidar-bg's impressive work in #29380 .
2019-06-30 13:58:07 +02:00
f7f6115f76
Proofread and improve the whole class reference
...
- 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-06-27 22:30:19 +02:00
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Hugo Locurcio
ConteZero
kobewi
Rémi Verschelde
Haoyu Qiu
Yuri Sizov
Rémi Verschelde
Nick Huelin
skyace65
Alexander Pech
Aaron Franke
PouleyKetchoupp
Bojidar Marinov