summaryrefslogtreecommitdiff
path: root/editor/editor_help.cpp
AgeCommit message (Collapse)Author
2023-01-05One Copyright Update to rule them allRémi Verschelde
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".
2022-12-09Fix left-aligned EditorHelp when first openedMicky
2022-11-29Use forward-declarations in big editor classestrollodel
2022-11-20Merge pull request #68904 from aaronfranke/texture-methodsRémi Verschelde
Rename TextureButton set_*_texture methods to set_texture_*
2022-11-20Double precision of `String.split_floats`Micky
2022-11-19Rename TextureButton set_*_texture methods to set_texture_*Aaron Franke
2022-11-17Add more call-to-action notes when documentation is missingYuri Sizov
2022-11-15Merge pull request #68159 from Mickeon/doc-help-return-arrayRémi Verschelde
Change docs' Typed Array & void representation
2022-11-15Change docs' Typed Array & void representationMicky
Typed Arrays now look the same as to how they're defined in GDScript. Also modifies "void" to be darkened and show a tooltip.
2022-11-14Merge pull request #68132 from Mickeon/doc-help-colourfulRémi Verschelde
Improve Editor Documentation colors
2022-11-02Style: Misc docs and comment style and language fixesRémi Verschelde
- Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-01Improve Editor Documentation colorsMicky
2022-10-31Merge pull request #67578 from KoBeWi/GEDITORRémi Verschelde
Unify usage of GLOBAL/EDITOR_GET
2022-10-31Merge pull request #68079 from Mickeon/doc-help-hintRémi Verschelde
Add tooltip to method qualifiers in Documentation Help
2022-10-31Add tooltip to method qualifiers in Documentation HelpMicky
2022-10-26Remove override_selected_font_color propertykobewi
2022-10-18Unify usage of GLOBAL/EDITOR_GETkobewi
2022-10-07Fix MSVC warnings, rename shadowed variables, fix uninitialized values, ↵bruvzg
change warnings=all to use /W4.
2022-09-11Add ability to flag classes as experimental or deprecated.SaracenOne
2022-09-06Fix theming error in EditorHelp due to order of operations issueYuri Sizov
2022-09-02Improve Docs' inheritance tree icons on newlineMicky
Uses a Non-Breaking Space to prevent the icon from detaching from the name on newline, improving the look considerably.
2022-08-29Rename String `plus_file` to `path_join`Aaron Franke
2022-08-29Revert "Remove NOTIFICATION_ENTER_TREE when paired with ↵Rémi Verschelde
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()`).
2022-08-28Merge pull request #64885 from Mickeon/rename-tooltip-hintRémi Verschelde
Rename `hint_tooltip` to `tooltip_text` & setter getter
2022-08-28Merge pull request #64847 from Mickeon/editor-docs-hierarchy-iconsRémi Verschelde
Add type icons to editor docs' hierarchy
2022-08-27Remove NOTIFICATION_ENTER_TREE when paired with NOTIFICATION_THEME_CHANGEDAaron Record
2022-08-27Rename `hint_tooltip` to `tooltip_text` & setgetMicky
`hint_tooltip` -> `tooltip_text` `set_tooltip` -> `set_tooltip_text` `_get_tooltip` -> `get_tooltip_text` Updates documentation, too.
2022-08-25Add type icons to editor docs' hierarchyMicky
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
2022-08-19Add documentation for all annotationsYuri Sizov
2022-08-08Add support for [param foo] syntax in valid documentation contextsYuri Sizov
2022-07-29Remove Signal connect bindsJuan Linietsky
Remove the optional argument p_binds from `Object::connect` since it was deprecated by Callable.bind(). Changed all uses of it to Callable.bind()
2022-07-17Add padding for code blocks in the editor helpHugo Locurcio
This improves their appearance, making them look closer to code blocks in the online manual.
2022-07-13Merge pull request #62710 from ↵Rémi Verschelde
Calinou/editor-help-improve-code-kbd-ref-highlight
2022-07-07Merge pull request #62108 from bruvzg/font_config_v3Rémi Verschelde
2022-07-06Merge pull request #62713 from YuriSizov/docs-scripting-annotationsRémi Verschelde
2022-07-06Refactor Font configuration and import UI, and Font resources.bruvzg
2022-07-05Implement a BitField hintreduz
Allows to specify the binder that an enum must be treated as a bitfield.
2022-07-05Improve visibility of code, kbd and clickable references in editor helpHugo Locurcio
This adds a background color for inline code, code blocks, keyboard shortcuts and clickable references (such as `[member something]`).
2022-07-04Add support for documenting built-in annotationsYuri Sizov
2022-06-29Fix `help_title_font_size` editor property to correctly apply to docsYuri Rubinsky
2022-06-01Merge pull request #60984 from fire-forge/doc-iconRémi Verschelde
Show class icon in the documentation page header
2022-05-30Fix help links with threaded RTL.bruvzg
2022-05-25Add type icon to documentation page headerFireForge
2022-05-21Fix class_desc_deselect handling of @GlobalScope.X linksSnailRhymer
Fix bug where links to class enums and class constants of the form @GlobalScope.X were broken. For an enum or constant with name "example_name", links of both forms @GlobalScope.example_name and example_name will now be correctly handled, including where example_name contains "." (e.g. Variant.Type).
2022-05-20Add a new HashSet templatereduz
* Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-19[RTL] Add support for shaping in background thread.bruvzg
2022-05-16Replace most uses of Map by HashMapreduz
* 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!
2022-05-12Fix _class_desc_select to handle Variant.TypeSnailRhymer
Change the order of checks in _class_desc_select to first try checking current page and GlobalScope before resorting to slicing either side of ".". Bug was caused by assumption that no enums or constants in @GlobalScope would contain ".". This is still assumed elsewhere in the file, so bugs may persist. Format some comments.
2022-04-23Rename theme properties to include underscoresFireForge
- check_vadjust -> check_v_adjust - close_h_ofs -> close_h_offset - close_v_ofs -> close_v_offset - commentfocus -> comment_focus - hseparation -> h_separation - ofs -> offset - selectedframe -> selected_frame - state_machine_selectedframe -> state_machine_selected_frame - table_hseparation -> table_h_separation - table_vseparation -> table_v_separation - vseparation -> v_separation
2022-03-22[Help] Add simulated slanted font support to the editor help.bruvzg