summaryrefslogtreecommitdiffstats
path: root/editor/editor_help.h
Commit message (Collapse)AuthorAgeFilesLines
* Fix copyright headers referring to GodotSpartan3222024-10-271-2/+2
|
* Rebrand preambles to RedotDubhghlas McLaughlin2024-10-111-0/+2
| | | | | | | | | | | | | | | | | | | | | | Credits: Co-authored-by: Skogi <skogi.b@gmail.com> Co-authored-by: Spartan322 <Megacake1234@gmail.com> Co-authored-by: swashberry <swashdev@pm.me> Co-authored-by: Christoffer Sundbom <christoffer_karlsson@live.se> Co-authored-by: Dubhghlas McLaughlin <103212704+mcdubhghlas@users.noreply.github.com> Co-authored-by: McDubh <103212704+mcdubhghlas@users.noreply.github.com> Co-authored-by: Dubhghlas McLaughlin <103212704+mcdubhghlas@users.noreply.github.com> Co-authored-by: radenthefolf <radenthefolf@gmail.com> Co-authored-by: John Knight <80524176+Tekisasu-JohnK@users.noreply.github.com> Co-authored-by: Adam Vondersaar <adam.vondersaar@uphold.com> Co-authored-by: decryptedchaos <nixgod@gmail.com> Co-authored-by: zaftnotameni <122100803+zaftnotameni@users.noreply.github.com> Co-authored-by: Aaron Benjamin <lifeartstudios@gmail.com> Co-authored-by: wesam <108880473+wesamdev@users.noreply.github.com> Co-authored-by: Mister Puma <MisterPuma80@gmail.com> Co-authored-by: Aaron Benjamin <lifeartstudios@gmail.com> Co-authored-by: SingleError <isaaconeoneone@gmail.com> Co-authored-by: Bioblaze Payne <BioblazePayne@gmail.com>
* Editor: Fix `EditorHelpBitTooltip` for Signals dockDanil Alexeev2024-07-051-0/+2
|
* Editor: Fix categories and tooltips in `TileSet` editorDanil Alexeev2024-05-141-1/+2
|
* Editor: Fix `EditorHelpBitTooltip` + `ProgressDialog` causes crashDanil Alexeev2024-05-081-0/+4
|
* Organize existing code for editor pluginsAaron Franke2024-04-271-1/+1
|
* Editor: Display deprecated/experimental messages in tooltipsDanil Alexeev2024-04-181-27/+65
|
* Editor Help: Add syntax highlighting for code blocksDanil Alexeev2024-03-091-0/+40
|
* Documentation: Add support for deprecated/experimental messagesDanil Alexeev2024-02-151-4/+4
|
* Merge pull request #85868 from KoBeWi/knowyourtilesRémi Verschelde2024-02-131-1/+3
|\ | | | | | | Add descriptions for tile properties
| * Add descriptions for tile propertieskobewi2023-12-071-1/+3
| |
* | Add color in built-in documentation for overridden propertiesMicky2024-02-111-0/+11
| |
* | GDExtension: add an interface for loading extra documentationRiteo2024-01-261-0/+6
| | | | | | | | | | | | | | | | | | | | | | 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>
* | Improve engine startup/shutdown benchmarksYuri Sizov2023-12-081-0/+1
|/ | | | | | | | | - 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>
* Polish & fix editor help cache generationPedro J. Estébanez2023-11-021-3/+2
| | | | | | | - 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.
* Improve threading in ClassDB and EditorHelpYuri Sizov2023-10-201-2/+5
|
* Merge pull request #82691 from YuriSizov/rst-validate-with-exceptionsRémi Verschelde2023-10-041-2/+2
|\ | | | | | | Validate `code` tags for class and member references
| * Validate `code` tags for class and member referencesYuri Sizov2023-10-031-2/+2
| | | | | | | | | | | | | | | | 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.
* | Revamp how documentation tooltips workMichael Alexsander2023-10-031-0/+27
|/
* Avoid text substitution in EditorHelp messagesHaoyu Qiu2023-09-051-9/+6
|
* Display `BitField[Enum]` in docs to distinguish from `Enum`Danil Alexeev2023-06-151-1/+1
|
* Improve and fix GDScript documentation generation & behaviorocean (they/them)2023-04-211-2/+2
| | | | | | 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.
* C#: Do not use DocCache when generating glue codeRedworkDE2023-04-201-1/+1
|
* Cache classes editor helpPedro J. Estébanez2023-04-131-0/+3
|
* Streamline class icon resolution in the editorYuri Sizov2023-03-311-1/+1
|
* Make EditorHelp respect font size settingsYuri Sizov2023-02-111-0/+8
|
* Make use of a theme cache in EditorHelp and ensure it's updatedYuri Sizov2023-02-111-16/+25
| | | | | | - Migrates the existing cache to the standard theme cache struct - Moves some parts of the codebase to use cache instead of ad-hoc fetching - Adds hooks to editor settings previously missing from theme regeneration
* Remove some unused signalsRémi Verschelde2023-01-311-2/+0
| | | | Part of #37604.
* One Copyright Update to rule them allRémi Verschelde2023-01-051-29/+29
| | | | | | | | | | | | | | | | | | | | As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
* Add more call-to-action notes when documentation is missingYuri Sizov2022-11-171-1/+1
|
* Revert "Remove NOTIFICATION_ENTER_TREE when paired with ↵Rémi Verschelde2022-08-291-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | NOTIFICATION_THEME_CHANGED" This reverts commit 4b817a565cab8af648c88cfc7ab6481e86ee3625. Fixes #64988. Fixes #64997. This caused several regressions (#64988, #64997, https://github.com/godotengine/godot/issues/64997#issuecomment-1229970605) which point at a flaw in the current logic: - `Control::NOTIFICATION_ENTER_TREE` triggers a *deferred* notification with `NOTIFCATION_THEME_CHANGED` as introduced in #62845. - Some classes use their `THEME_CHANGED` to cache theme items in member variables (e.g. `style_normal`, etc.), and use those member variables in `ENTER_TREE`, `READY`, `DRAW`, etc. Since the `THEME_CHANGE` notification is now deferred, they end up accessing invalid state and this can lead to not applying theme properly (e.g. for EditorHelp) or crashing (e.g. for EditorLog or CodeEdit). So we need to go back to the drawing board and see if `THEME_CHANGED` can be called earlier so that the previous logic still works? Or can we refactor all engine code to make sure that: - `ENTER_TREE` and similar do not depend on theme properties cached in member variables. - Or `THEME_CHANGE` does trigger a general UI update to make sure that any bad theme handling in `ENTER_TREE` and co. gets fixed when `THEME_CHANGE` does arrive for the first time. But that means having a temporary invalid (and possibly still crashing) state, and doing some computations twice which might be heavy (e.g. `EditorHelp::_update_doc()`).
* Merge pull request #64847 from Mickeon/editor-docs-hierarchy-iconsRémi Verschelde2022-08-281-0/+1
|\ | | | | Add type icons to editor docs' hierarchy
| * Add type icons to editor docs' hierarchyMicky2022-08-251-0/+1
| | | | | | | | | | | | The "Inherits" and "Inherited by" section of the docs now display the icon of each Object on the side. Also scales the main class' icon to match title font
* | Remove NOTIFICATION_ENTER_TREE when paired with NOTIFICATION_THEME_CHANGEDAaron Record2022-08-271-1/+0
|/
* Add support for documenting built-in annotationsYuri Sizov2022-07-041-0/+1
|
* Fix `help_title_font_size` editor property to correctly apply to docsYuri Rubinsky2022-06-291-0/+2
|
* Fix help links with threaded RTL.bruvzg2022-05-301-0/+3
|
* Replace most uses of Map by HashMapreduz2022-05-161-7/+7
| | | | | | | | | | | | * Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
* Style: Partially apply clang-tidy's `cppcoreguidelines-pro-type-member-init`Rémi Verschelde2022-05-021-2/+2
| | | | | | | | | | | Didn't commit all the changes where it wants to initialize a struct with `{}`. Should be reviewed in a separate PR. Option `IgnoreArrays` enabled for now to be conservative, can be disabled to see if it proposes more useful changes. Also fixed manually a handful of other missing initializations / moved some from constructors.
* Zero initialize all pointer class and struct membersRémi Verschelde2022-04-041-14/+14
| | | | | This prevents the pitfall of UB when checking if they have been assigned something valid by comparing to nullptr.
* Initialize bools in the headers in editorAaron Franke2022-03-121-2/+2
|
* Fix theming of doc backgroundYuri Roubinsky2022-01-301-1/+1
|
* [Editor] Do not update editor help theme, if calculated margin hasn't changed.bruvzg2022-01-241-0/+1
|
* Improve spacing in built-in class referenceYuri Sizov2022-01-181-4/+8
|
* Generate editor docs on a threadreduz2022-01-071-1/+8
| | | | | | | * The main generation could not be moved to a thread, as it instantiates classes to get default values, interacts with ProjectSettings, etc. * Only uncompressing documentation and merging it is threaded. * Seems to improve editor load times by 0.5 seconds.
* Update copyright statements to 2022Rémi Verschelde2022-01-031-2/+2
| | | | Happy new year to the wonderful Godot community!
* Sort and group theme properties in docs, improve formatting for theme and enumsYuri Sizov2021-12-011-0/+2
|
* Move the docs for constructors and operators out of methods sectionAaron Franke2021-10-291-0/+2
|
* Remove unimplemented methodsMarcel Admiraal2021-10-211-3/+0
|
* Added status bar and toggle scripts panel button to EditorHelp/VScriptsYuri Roubinsky2021-09-151-0/+5
|