Commit Graph

388 Commits

Author SHA1 Message Date
f468e59efd GDExtension: add an interface for loading extra documentation
Adds two new GDExtension interface methods:
 - `editor_help_load_xml_from_utf8_chars`
 - `editor_help_load_xml_from_utf8_chars_and_len`

Both of these methods parse the XML passed into an extra documentation
container which, when needed, is merged into the main doc container.

Co-Authored-By: Rémi Verschelde <rverschelde@gmail.com>
2024-01-26 13:53:33 +01:00
dc86483e3a Add inheriting classes to DocTools 2024-01-16 14:42:36 +01:00
95b27fe8c7 Reorganize code related to editor theming
This change introduces a new EditorThemeManager class
to abstract theme generatio and its subroutines.

Logic related to EditorTheme, EditorColorMap, and editor
icons has been extracted into their respective files with
includes cleaned up.

All related files have been moved to a separate folder to
better scope them in the project. This includes relevant
generated files as well.
2024-01-16 11:57:45 +01:00
0e8f90f4c8 Update deferred calls to use Callables 2024-01-09 16:11:47 +01:00
a3cb1b096f Add const references detected by clang-tidy 2023-12-16 13:36:44 -05:00
fc3f40f37d Improve engine startup/shutdown benchmarks
- Add contexts to give a better sense of benchmarked areas.
- Add missing benchmarks and adjust some begin/end points.
- Clean up names.
- Improve Android's internal benchmarks in a similar manner.

Co-authored-by: Fredia Huya-Kouadio <fhuya@meta.com>
2023-12-08 12:53:04 +01:00
6e31c413b6 Add descriptions for tile properties 2023-12-07 16:57:34 +01:00
a1d8fc1af9 Polish & fix editor help cache generation
- Isolated the generation of extensions's docs. They're now not cached and refreshed as needed.
- Removed superfluous sorting of the class list.
- Removed some superfluous/unused elements.
- Renamed some items for clarity.
2023-11-02 13:46:37 +01:00
9b03fb36f9 Improve threading in ClassDB and EditorHelp 2023-10-20 22:14:04 +02:00
215e036600 Add bulk change guards to successive theme overrides in Editor and GUI 2023-10-19 18:14:14 +02:00
f56532c577 Editor: Fix some issues with EditorHelpTooltip 2023-10-10 20:02:47 +03:00
eb824dc6a5 Tweak metadata property tooltip to avoid being misleading 2023-10-07 03:08:16 +02:00
b9bf46de9e Merge pull request #82067 from dalexeev/gds-docgen-fix-metatypes-and-values
GDScript DocGen: Fix and improve appearance of metatypes and values
2023-10-05 10:07:43 +02:00
1e544505be Merge pull request #82691 from YuriSizov/rst-validate-with-exceptions
Validate `code` tags for class and member references
2023-10-04 15:42:42 +02:00
ae91644c73 Revamp how documentation tooltips work 2023-10-03 17:40:51 -03:00
cc0eebd9d8 Validate code tags for class and member references
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.

Warnings are now enabled on CI to prevent future errors.
2023-10-03 15:48:31 +02:00
bc6585a5a7 [RTL] Add support for image dynamic updating, padding, tooltips and size in percent. 2023-09-26 09:39:51 +03:00
426ccba70e GDScript DocGen: Fix and improve appearance of metatypes and values 2023-09-21 20:44:34 +03:00
3a585a6bcf Merge pull request #81346 from timothyqiu/interning
Avoid text substitution in EditorHelp messages
2023-09-06 14:49:37 +02:00
e350034251 Avoid text substitution in EditorHelp messages 2023-09-05 23:15:34 +08:00
6de34fde27 Add EditorStringNames singleton 2023-09-03 19:58:18 +02:00
398ca4e71a Use the gray color for all abstract classes 2023-08-31 12:59:18 +03:00
41efc7cb86 Merge pull request #78941 from dalexeev/gds-doc-comments-deprecated-and-experimental
GDScript: Add `@deprecated` and `@experimental` doc comment tags
2023-07-31 21:01:08 +02:00
92960b7a22 Merge pull request #78615 from RandomShaper/fix_doc_cache
Re-enable docs cache with fixes
2023-07-26 18:39:22 +02:00
0231611ee0 Merge pull request #79206 from raulsntos/doc-mention-csharp-differences
Add a warning about C# differences in classref doc
2023-07-14 18:49:36 +02:00
22b4861d7b Merge pull request #78649 from MewPurPur/dont-link-to-own-page
Tweak documentation to use bold font when a class is referencing itself
2023-07-12 17:16:47 +02:00
5dff3c4484 Merge pull request #78538 from Sauermann/fix-code-simplifications
Remove unnecessary value assignments throughout the codebase
2023-07-12 15:09:26 +02:00
a164e3e7b3 Add a note about C# differences in classref doc 2023-07-09 01:44:48 +02:00
c1b450566a GDScript: Add @deprecated and @experimental doc comment tags 2023-07-08 18:13:19 +03:00
cac4d44cde Re-enable docs cache with fixes 2023-07-05 10:44:58 +02:00
d48636c3bf Fix regression with enum descriptions now showing up in documentation. 2023-07-02 11:29:52 -04:00
da4590b3f1 Unexpose DocCache class 2023-06-24 22:24:54 +03:00
0786876077 Tweak documentation to use bold font when a class is referencing itself 2023-06-24 18:09:31 +02:00
7afb9dd275 Disable doc cache temporarily for pre-RC stabilization 2023-06-23 16:40:40 +02:00
890fdd56df Code simplifications
CPPcheck found most of them.

no need to assign the variable twice:
- AnimationTrackEditTypeAudio
- SSEffects

variable is assigned in all if-else clauses:
- EditorHelp
- AndroidInputHandler
- MenuBar
- ShaderCompiler

same if clause:
- ItemList

clearing an empty bitfield has no effect:
- Viewport
2023-06-21 22:37:26 +02:00
eb391d3302 Display BitField[Enum] in docs to distinguish from Enum 2023-06-15 17:23:02 +03:00
f9836fed72 Use right type in the binding of DocCache::classes 2023-06-02 22:03:21 +02:00
67e8c57f03 Invalidate the DocCache when updating the xml docs 2023-05-28 17:08:27 +02:00
831b4a5366 Improve startup benchmarking
Move the benchmarking measuring methods from `Engine` to `OS` to allow for platform specific overrides (e.g: can be used to hook into platform specific benchmarking and tracing capabilities).
2023-05-23 13:22:35 -07:00
8ab2cf3d2d Use defined key mapping for closing popups and dialogs
As opposed to hardcoding the escape key. Also removed such hardcoding in a few other places as well as a hardcoded enter key in one of the affected input fields.
2023-05-20 17:39:59 -07:00
716f788b98 Merge pull request #77033 from dalexeev/editor-help-fix-array-links
EditorHelp: Fix displaying typed `Array` links
2023-05-15 09:34:35 +02:00
28f391f301 Exclude overriden properties from Property Descriptions section 2023-05-14 17:41:14 +02:00
a16b2fc3b6 EditorHelp: Fix displaying typed Array links 2023-05-13 16:09:35 +03:00
012e2b7411 Merge pull request #76539 from anvilfolk/gddocsreg
Fix wrongly removing prefix when generating in-editor documentation
2023-04-28 17:08:05 +02:00
6f8113721d Fix wrongly removing prefix when generating in-editor documentation
Co-authored-by: Danil Alexeev <danil@alexeev.xyz>
2023-04-28 07:38:36 -04:00
4aaa2e6477 Fix wait for thread not started 2023-04-27 20:28:22 +02:00
26fb911f79 Merge pull request #72095 from anvilfolk/gd-docs
Improve GDScript documentation generation & behavior
2023-04-26 16:54:25 +02:00
e1ce0340b7 Improve reliability of editor docs cache 2023-04-25 11:40:56 +02:00
6783ff69c0 Improve and fix GDScript documentation generation & behavior
Removes documentation generation (docgen) from the GDScript compiler to
its own file. Adds support for GDScript enums and signal parameters and
quite a few other assorted fixes and improvements.
2023-04-21 10:17:30 -04:00
15442b54a8 Fix EditorHelp failing to load 2023-04-21 01:25:47 +02:00