Commit graph

225 commits

Author SHA1 Message Date
Hugo Locurcio
3c8abbc4bf
doc: Move the class description to be just below the brief description
- Drop the "Brief description" header as it became redundant
  with this change.
- Fix a bug in the editor help where an extraneous newline was added
  after the header if the class isn't inherited by any others.
- Remove the Category line in the rST markup as it's not useful
  for API users.
2020-01-15 00:05:34 +01:00
Rémi Verschelde
a7f49ac9a1 Update copyright statements to 2020
Happy new year to the wonderful Godot community!

We're starting a new decade with a well-established, non-profit, free
and open source game engine, and tons of further improvements in the
pipeline from hundreds of contributors.

Godot will keep getting better, and we're looking forward to all the
games that the community will keep developing and releasing with it.
2020-01-01 11:16:22 +01:00
Haoyu Qiu
078c0d75f2 Cleans up headers included in editor_node.h 2019-12-24 21:46:05 +08:00
Haoyu Qiu
d3851d5452 Show enum class name when not on the same doc page
Variant.Type and Variant.Operator are listed on GlobalScope page instead
of Variant. The `Variant` prefix should not be omitted on that page.
2019-12-14 18:46:34 +08:00
Haoyu Qiu
249c2c4615 Makes int and bool clickable in documentation
Also adjusted the way to check empty strings.
2019-12-13 21:53:52 +08:00
Yuri Roubinsky
0ec76d40b4 Fix incorrect error label color when switching from light to dark theme 2019-11-14 13:34:56 +03:00
Yuri Roubinsky
facfae3671 Fix "matches" label color in light theme 2019-11-14 09:44:53 +03:00
PouleyKetchoupp
74271712a8 Code sections improvements in editor help
- Removed extra new lines around code blocks
- Different color for code and code blocks to make them more visible
2019-10-31 18:47:12 +01:00
volzhs
69c5d637f2 Recalculate margin based on help source font size 2019-10-25 03:28:53 +09:00
Yuri Roubinsky
d7d72aeeec Prevents segfault on _class_desc_resized at exit 2019-10-22 16:01:11 +03:00
Yuri Roubinsky
c1bd94c2a4 Fix incorrect coloring of in-editor documentation when theme changed 2019-10-15 09:54:28 +03:00
Marqus
c84e73bf92 Add shortcut Shift + F3 to search pervious in the built-in docs
When using the built-in docs, Godot would not support the shortcut "Shift + F3"
to search for the previous occurrence of the search entry text, thus causing an
inconsistent behaviour when using shortcuts in the "ScriptEditor" compared to
using them in the "ScriptTextEditor".

The previous parameter of the function "EditorHelp::_search()" in the class
"editor_help" seems to be unused, thus replaced with a bool representing to
search for previous search entry text or not. By adding the shortcut to
Godot's "ScriptEditor", this commit now improves Godot's consistensy when
using shortcuts.

Fixes #31147.

Co-Authored-By: Oscar Ferm <oscfer-6@student.ltu.se>
2019-10-10 11:01:04 +02:00
Hanif Bin Ariffin
ccfc88ffba Applied the same kind of ordering to methods description
Previously, the ordering did not match.
This could be improved by doing the filtering behorehand, then we simply access them.
This will make sure that future changes to one is reflected to the other (because we are only doing it once)
2019-10-03 12:31:41 -04:00
Rémi Verschelde
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
Rémi Verschelde
db47221b8c
Merge pull request #32225 from Calinou/improve-editor-help-display
Improve the editor help display
2019-09-24 09:52:21 +02:00
Hugo Locurcio
5b3805b8e5
Improve the editor help display
- Write the type after the parameter name for consistency with
  the GDScript static typing syntax.
- Remove ":" after headers since they're already distinguished
  by their size.
- Remove spaces before/aftere parentheses in method/signal
  argument lists.
2019-09-20 22:41:31 +02:00
Hugo Locurcio
bee38c6b0b
Find the previous match in the editor help when pressing Shift + Enter 2019-09-08 15:10:57 +02:00
Bojidar Marinov
6c4407bae4
Add overriden properties to the documentation
Fixes #31855
2019-09-04 15:21:40 +03:00
Hugo Locurcio
d6984f7311
Increase line spacing in the editor help and asset library descriptions
This makes for more readable text.
2019-08-30 15:08:24 +02:00
Hugo Locurcio
e564bffd90
Add horizontal margins to the editor help based on width
This decreases the number of characters per line, and therefore
helps make the editor help more readable.
2019-08-23 01:42:29 +02:00
Michael Alexsander Silva Dias
95a8b2b5d9 Make the script search have a proper matches counter 2019-08-13 09:29:49 -03:00
Michael Alexsander Silva Dias
790f9f628c Show matches found when searching the docs 2019-08-09 04:09:22 -03:00
unknown
c5d4bd9e34 Fixed editor_doc properties font alignment bug 2019-07-15 19:18:51 +05:30
Hugo Locurcio
28d3a6051c
Use base Color() constructors instead of Color::html()
This results in slightly smaller binaries (-17 KB for an editor binary)
as no strings need to be allocated.
2019-07-08 21:17:10 +02:00
Rémi Verschelde
d17eac735c
Merge pull request #29815 from NilsIrl/plus_file_1
Replace ` + "/" + ` with `String::file_add()`
2019-07-01 12:06:35 +02:00
Bojidar Marinov
0c4c36d823
Add default values to the editor help, docs, and generated RST
Also, make spacing of "=" in the editor help a bit more consistent.
Closes #16086
2019-06-27 18:29:35 +03:00
Rémi Verschelde
eaaff9da31
Merge pull request #29941 from qarmin/redundant_code_and_others
Remove redundant code, possible NULL pointers and others
2019-06-27 01:05:18 +02:00
qarmin
4e5310cc60 Some code changed with Clang-Tidy 2019-06-26 15:08:25 +02:00
Nils ANDRÉ-CHANG
d2833d4f4d Replace + "/" + with String::file_add() 2019-06-23 13:33:50 +01:00
Elia Sarti
81065d53df Fix for #29810
Ensure indentation works properly in rich text
Fix formatting
2019-06-20 11:42:25 +01:00
Hugo Locurcio
a100471f6b
Add support for bold fonts in the editor help
This also makes it possible to use the strikethrough tag (`[s]`)
in the editor help.
2019-06-15 18:47:42 +02:00
Hugo Locurcio
6516098d12
Use uppercase for all hexadecimal constants in the editor help 2019-06-05 16:44:20 +02:00
Daw11
ce6ab56e9f Fix the unclickable links inside the doc
Fixes #27384
2019-04-27 21:30:08 +02:00
Rémi Verschelde
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough
EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-05 15:19:21 +02:00
Ignacio Etcheverry
c8aa85189a EditorHelp, makerst: Improve enum ref resolving and constant ref support
Enum reference resolving will now search in the @GlobalScope if no class is specified and the enum cannot be resolved in the current class.
Added support for constant references in EditorHelp, e.g.: [constant KEY_ENTER] or [constant Control.FOCUS_CLICK]. It supports enum constants (the enum name must not be included).
2019-03-29 23:40:31 +01:00
Hugo Locurcio
9ba6738719
Use the accent color to highlight selected text
This makes selections easier to see, while making them fit better
within the editor theme.

This closes #22552.
2019-03-27 22:12:41 +01:00
Michael Alexsander Silva Dias
fe893bd6ef Fix description size in "New Node" dialog 2019-02-17 19:06:42 -03:00
Michael Alexsander Silva Dias
4fd7115e13 General cleanup of script and doc search bars 2019-02-10 14:18:08 -02:00
Marc Gilleron
ae9a23e36c Moved script editor search bar to the bottom, so it doesn't shift everything down 2019-01-31 16:44:40 +01:00
Rémi Verschelde
b16c309f82 Update copyright statements to 2019
Happy new year to the wonderful Godot community!
2019-01-01 12:58:10 +01:00
Ray Koopa
fddffa9eb8 Unify editor class and reference search
Co-authored-by: Michael Alexsander Silva Dias <michaelalexsander@protonmail.com>
2018-11-20 20:52:27 -02:00
Michael Alexsander Silva Dias
7144e2fde4 Add more places to hide guides if relationship lines are enabled 2018-11-19 03:05:01 -02:00
Rémi Verschelde
06a133bdd1
Merge pull request #23518 from volzhs/confirmed_already_connected
Fix error with a specific dock layout
2018-11-05 13:06:27 +01:00
Rémi Verschelde
5f8af252e8 doc: Use HTTPS for docs.godotengine.org and point to latest branch
Fixes #23509.
2018-11-05 08:46:27 +01:00
volzhs
9f62f79dbb Fix error with a specific dock layout 2018-11-05 11:45:25 +09:00
Rémi Verschelde
c026e3957a Fix warnings on virtual methods [-Woverloaded-virtual] [-Wdelete-non-virtual-dtor]
Fixes the following Clang 7 warnings:
```
editor/editor_help.h:123:7: warning: 'EditorHelpIndex::popup' hides overloaded virtual function [-Woverloaded-virtual]
editor/editor_help.h:95:7: warning: 'EditorHelpSearch::popup' hides overloaded virtual function [-Woverloaded-virtual]
editor/editor_help.h:96:7: warning: 'EditorHelpSearch::popup' hides overloaded virtual function [-Woverloaded-virtual]
editor/plugins/curve_editor_plugin.h:141:15: warning: 'CurvePreviewGenerator::generate' hides overloaded virtual function [-Woverloaded-virtual]
editor/plugins/script_editor_plugin.h:70:7: warning: 'ScriptEditorQuickOpen::popup' hides overloaded virtual function [-Woverloaded-virtual]
editor/quick_open.h:69:7: warning: 'EditorQuickOpen::popup' hides overloaded virtual function [-Woverloaded-virtual]
main/tests/test_io.cpp:53:15: warning: 'TestIO::TestMainLoop::input_event' hides overloaded virtual function [-Woverloaded-virtual]
servers/audio/effects/audio_effect_record.h:69:15: warning: 'AudioEffectRecordInstance::process_silence' hides overloaded virtual function [-Woverloaded-virtual]

core/os/memory.h:119:2: warning: destructor called on non-final 'ContextGL_X11' that has virtual functions but non-virtual destructor [-Wdelete-non-virtual-dtor]
core/os/memory.h:119:2: warning: destructor called on non-final 'EditorScriptCodeCompletionCache' that has virtual functions but non-virtual destructor [-Wdelete-non-virtual-dtor]
core/os/memory.h:119:2: warning: destructor called on non-final 'Engine' that has virtual functions but non-virtual destructor [-Wdelete-non-virtual-dtor]
core/os/memory.h:119:2: warning: destructor called on non-final 'PhysicalBone::JointData' that has virtual functions but non-virtual destructor [-Wdelete-non-virtual-dtor]
core/os/memory.h:119:2: warning: destructor called on non-final 'VisualServerScene' that has virtual functions but non-virtual destructor [-Wdelete-non-virtual-dtor]
core/os/memory.h:119:2: warning: destructor called on non-final 'VisualServerViewport' that has virtual functions but non-virtual destructor [-Wdelete-non-virtual-dtor]
```
2018-10-02 13:40:17 +02:00
DualMatrix
c1674f1068 Fixed empty item slipping into Search Classes dialog
Fixed empty item slipping into Search Classes dialog.

Phew tracking this down was weird.
2018-09-17 12:41:47 +02:00
willnationsdev
5436abefe4 Refactor editor icon retrieval 2018-09-14 09:27:56 -05:00
Rémi Verschelde
ba64ea2283 Doc: Use same headers and order in-editor and online 2018-09-12 17:12:23 +02:00
Rémi Verschelde
277b24dfb7 Make core/ includes absolute, remove subfolders from include path
This allows more consistency in the manner we include core headers,
where previously there would be a mix of absolute, relative and
include path-dependent includes.
2018-09-12 09:52:22 +02:00
Michael Alexsander Silva Dias
8c74257d68 Make "Search Classes" dialog have relationship lines if the setting is enabled 2018-08-31 21:48:56 -03:00
Rémi Verschelde
52466d57e9 Make some debug prints verbose-only, remove others 2018-08-24 14:59:01 +02:00
Juan Linietsky
0a8ac1a57c display some constants as hex 2018-08-21 17:13:16 -03:00
Alexander Holland
5ba083ea1b changed search help selection color 2018-08-19 22:06:20 +02:00
Rémi Verschelde
4170aa3f39
Merge pull request #20956 from volzhs/update-help
Update help doc when changing font size
2018-08-13 20:46:38 +02:00
Rémi Verschelde
68ab428d4d
Merge pull request #20155 from Tunous/line-edit-clear
Add clear button to search fields
2018-08-13 12:54:57 +02:00
Rémi Verschelde
652eb9347c
Merge pull request #20668 from SaracenOne/enum_help_fix
Fixes the hyperlinks for enumerators inside classes in the editor help.
2018-08-13 12:22:21 +02:00
volzhs
1574c3a186 Update help doc when changing font size 2018-08-13 09:59:59 +09:00
Łukasz Rutkowski
81fb81de9d Do not use theme to set LineEdit right_icon 2018-08-11 12:04:26 +02:00
Łukasz Rutkowski
e8a435c8cd Add clear text button to LineEdit
- Add pressed state to clear button
- Enable clear button on all inputs with search icon
- Remove duplicate clear buttons
- Fix rendering of icon for center and right alignments
- Add clear button to more search fields
- Add clear icon to default theme
- Add method to control enabled state of clear button
- Add property to enable clear button from inspector
2018-08-11 12:04:26 +02:00
Saracen
63c6a2487f Fixes the hyperlinks for enumerators inside classes in the editor help. 2018-08-02 09:40:36 +01:00
Bernhard Liebl
ba974b8d1e Allow some non-integer built-in constants in gdscript 2018-07-31 17:56:48 +02:00
Juan Linietsky
336db8bcd1 -Fix tooltips in inspector, now they show as rich text. 2018-07-20 18:16:19 -03:00
robojumper
98b59cf2a3 Add support for tutorial links to makerst.py
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
Guilherme Felipe
22041264ed [Doc] Fixes in find bar
- Automatically select all text when find bar called.
- Adjust the size height when first displayed.
2018-05-16 12:11:20 -03:00
Guilherme Silva
d63cc11bee Change from "search dialog" to "search bar" on help screen 2018-05-08 12:19:32 +00:00
Felix Yang
7d5a40c3e6 Ctrl+Clicking a enum now scrolls down to it in the docs. 2018-04-03 21:56:54 +02:00
Marcelo Fernandez
621d28adef Fix for a possible compile error under OS X 2018-02-14 19:48:35 -03:00
Juan Linietsky
03475ba197 Filled tutorial field in most relevent classes.
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
Rémi Verschelde
e4213e66b2 Add missing copyright headers and fix formatting
Using `misc/scripts/fix_headers.py` on all Godot files.
Some missing header guards were added, and the header inclusion order
was fixed in the Bullet module.
2018-01-05 01:22:23 +01:00
Rémi Verschelde
b50a9114b1 Update copyright statements to 2018
Happy new year to the wonderful Godot community!
2018-01-01 14:40:47 +01:00
Noshyaar
a6328011d8
Merge pull request #14973 from poke1024/docs-word-selection
Double-click word selection for RichTextLabel (i.e. docs)
2018-01-01 18:51:35 +07:00
Bernhard Liebl
b80bc553dd Double-click word selection for RichTextLabel (i.e. docs) 2017-12-28 17:44:22 +01:00
Daniel J. Ramirez
fec41618dc Minor style fixes for editor help 2017-12-27 10:35:26 -06:00
Noshyaar
3f193af893
Merge pull request #14808 from YeldhamDev/script_editor_fixes
Some fixes for the Script Editor and dead code cleaning.
2017-12-25 08:27:38 +07:00
Guilherme Felipe
8adf7c3ef2 Add method_descr again because it's required for classes that
don't have public methods. revert #14814
2017-12-18 22:47:17 -02:00
Guilherme Felipe
5c0271eed7 Fix doc methods not showing up 2017-12-18 20:35:15 -02:00
Michael Alexsander Silva Dias
36e835bbd4 Some fixes for the Script Editor and dead code cleaning. 2017-12-18 15:46:17 -02:00
poke1024
9cfc4440c1 Docs methods grouping by prefix 2017-12-16 20:02:10 +01:00
Rémi Verschelde
a845411454 Style: Re-apply clang-format over recent invalid additions 2017-12-10 01:27:02 +01:00
poke1024
ef49edc387 Make "Search Help" more responsive 2017-12-06 23:01:17 +01:00
Bernhard Liebl
d6a95e154a Make editor help select shortest (best) instead of first match 2017-11-29 07:20:11 +01:00
George Marques
1ac26faa5c
Add extra link tags for editor help
Now [member], [enum], and [signal] tags give links to their respective
definitions.
2017-11-20 22:18:50 -02:00
Rémi Verschelde
e7701bb2de doc: Rename "@Global Scope" to "@GlobalScope"
Spaces in filenames are evil.
2017-11-15 20:41:16 +01:00
Zher Huei Lee
34f4ae18b8 Moved doc description formatting. Fixes #12798
Paragraph spacing is now applied only during rendering (so doctool
preserves formatting).

Paragraph spacing now no longer applies within [code] tags.

Extra bbcode is now ignored within [code] tags.
2017-11-12 22:32:59 +08:00
Bernhard Liebl
8c6cc4dc2d Docs cosmetics: add more space to Signals, Enumerations, Constants;
aligned table layout for setters and getters
2017-11-04 14:09:45 +01:00
Rémi Verschelde
0c9d201044 Merge pull request #11407 from toger5/selection_override_color
added option to keep font color on selection + use consistent selection color in help (fixes: #11501)
2017-10-15 20:49:38 +02:00
Poommetee Ketson
98322a8876
EditorHelp: use '<' to show inheritance
...making it consistent with official docs
2017-10-13 20:02:48 +07:00
toger5
541b0d0238 fixed help bg 2017-09-28 23:21:44 +02:00
toger5
d9272bfdbf always use the adaptive code theme selection color in help since it wont changed based on the code theme anyways. 2017-09-28 14:17:35 +02:00
toger5
d58a159e38 keep font color on selection as default 2017-09-28 14:17:14 +02:00
Gilles Roudiere
6f185cc9f7 Remove unecessary anchors&margins set causing bad display (sons of containers) 2017-09-27 00:38:28 +02:00
Gilles Roudiere
05bb8e0c10 Remove set_area_as_parent_rect and replace it by set_anchors_and_margins_preset(PRESET_WIDE) 2017-09-22 11:39:44 +02:00
Daniel J. Ramirez
d21f20eb5f Several fixed to editor doc.
Improved style
Fixed editor help issues
Added editor help index
2017-09-14 01:13:37 -05:00
Rémi Verschelde
e73e00d369 Style: Apply clang-format to @reduz's changes
[ci skip]
2017-09-13 09:13:34 +02:00
Juan Linietsky
5cb90ad67e When method or property has no description, a link asks you to create it 2017-09-12 19:16:59 -03:00
Rémi Verschelde
4e392517da DocData: Drop unused brief description for properties 2017-09-12 23:31:27 +02:00
Daniel J. Ramirez
57fff67580 Fixed some inconsistent styles, plus some cleanup 2017-09-12 13:16:47 -05:00
toger5
07d5911c40 fixed copy on osx + help selection color 2017-09-04 18:57:52 +02:00
toger5
b606285219 Unified script panel backgrounds.
- simplefied it with using the new rtl.
 - removed ("ScriptPanel", "EditorStyles") for since rtl now can be used
 - unified backgrounds when script editor color is set to transparent => option to set background color adapt to theme is deprecated.
2017-09-02 18:28:35 +02:00
toger5
7793bfc544 added icon updating to most ui elements 2017-08-30 21:47:09 +02:00
Rémi Verschelde
7ad14e7a3e Dead code tells no tales 2017-08-27 22:13:45 +02:00
Rémi Verschelde
bd282ff43f Use HTTPS URL for Godot's website in the headers 2017-08-27 14:16:55 +02:00
Rémi Verschelde
5976e8d7de Merge pull request #10625 from Rubonnek/fixed-leaks
Fixed several memory leaks
2017-08-27 02:10:32 +02:00
Ignacio Etcheverry
4314050ea7 EditorHelp: Fixes desc of vararg methods 2017-08-26 23:15:34 +02:00
Wilson E. Alvarez
1577f41653 Fixed several memory leaks 2017-08-25 08:47:05 -04:00
Juan Linietsky
3d1c031871 Changed MethodBind API to request information from methods. It's much claner now.
Also changed PropertyInfo to include informatino about class names.
2017-08-23 19:11:11 -03:00
Wilson E. Alvarez
433c01b7e5 Removed EditorHelp::_scroll_changed 2017-08-23 03:04:16 -04:00
toger5
a9da258a65 fixed loading old theme styleboxes 2017-08-08 18:36:35 +02:00
Juan Linietsky
a0d969c560 Revert "fixed loading old theme styleboxes" 2017-08-07 16:00:34 -03:00
Rémi Verschelde
b31ba2f187 Merge pull request #10097 from toger5/asset_lib_style_overrides
fixed loading old theme styleboxes
2017-08-07 14:47:27 +02:00
toger5
f035e4a24a fixed loading old theme styleboxes 2017-08-05 01:33:46 +02:00
toger5
3b2a4cc52a editor: update helps and script panel on theme could change. 2017-08-04 14:57:15 +02:00
Daniel J. Ramirez
95f55c8f0d Icons can now be added inside line edits (Search icon).
Fixed window title bar margins.

fixed compilation error
2017-07-19 13:23:16 -05:00
Poommetee Ketson
da8734bd30 EditorHelpBit: fix stylebox error of some instances 2017-07-13 01:27:26 +07:00
Poommetee Ketson
e3998528e0 BuildSystem: generated files have .gen.extension 2017-06-25 07:55:01 +07:00
Poommetee Ketson
6e1bcb2b44 Fix Script Editor stealing focus on class search text changed 2017-06-07 07:46:26 +07:00
Poommetee Ketson
ef7d1b1571 EditorHelp: Help>Class now switch to script editor 2017-05-31 23:54:54 +07:00
Nuno Donato
7661cb5a62 Added an help menu
Also renamed the "tutorials" button in the script editor to be consistent with the help menu entry.
Fixed #8921
2017-05-26 16:20:33 +01:00
volzhs
fab3c4308c Show description box on create new node window 2017-05-22 21:39:10 +09:00
Juan Linietsky
5b3709d309 Removal of InputEvent as built-in Variant type..
this might cause bugs I haven't found yet..
2017-05-20 17:05:38 -03:00
Rémi Verschelde
df61dc4b2b Add "Godot Engine contributors" copyright line 2017-04-08 00:11:42 +02:00
Rémi Verschelde
debeee56f7 Fix typos in source code using codespell
From https://github.com/lucasdemarchi/codespell
2017-03-24 21:45:31 +01:00
Rémi Verschelde
5dbf1809c6 A Whole New World (clang-format edition)
I can show you the code
Pretty, with proper whitespace
Tell me, coder, now when did
You last write readable code?

I can open your eyes
Make you see your bad indent
Force you to respect the style
The core devs agreed upon

A whole new world
A new fantastic code format
A de facto standard
With some sugar
Enforced with clang-format

A whole new world
A dazzling style we all dreamed of
And when we read it through
It's crystal clear
That now we're in a whole new world of code
2017-03-05 16:44:50 +01:00
Rémi Verschelde
49c065d29c Refactoring: rename tools/editor/ to editor/
The other subfolders of tools/ had already been moved to either
editor/, misc/ or thirdparty/, so the hiding the editor code that
deep was no longer meaningful.
2017-03-05 14:21:25 +01:00
Renamed from tools/editor/editor_help.cpp (Browse further)