diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-08-07 12:36:51 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-07 12:36:51 +0200 |
| commit | cd68ef9ed08579ba0a73a57264f16611ceb7a2a4 (patch) | |
| tree | b4c2824d50cf6542b12a413d34e5cd657b8f2607 /doc | |
| parent | 35b08b7cbc4e4efef63b09271b5ba013606e138b (diff) | |
| parent | ecf42e22352e81c55cbc123cf7ac349eab5fac35 (diff) | |
Merge pull request #51328 from pycbouh/docs-inspector-plugins-classref
Improve the inspector plugin documentation and remove a confusing statement
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/EditorInspectorPlugin.xml | 7 | ||||
| -rw-r--r-- | doc/classes/EditorProperty.xml | 4 |
2 files changed, 6 insertions, 5 deletions
diff --git a/doc/classes/EditorInspectorPlugin.xml b/doc/classes/EditorInspectorPlugin.xml index 085568466a..62fd7a1d6e 100644 --- a/doc/classes/EditorInspectorPlugin.xml +++ b/doc/classes/EditorInspectorPlugin.xml @@ -13,6 +13,7 @@ On each of these calls, the "add" functions can be called. </description> <tutorials> + <link title="Inspector plugins">https://docs.godotengine.org/en/latest/tutorials/plugins/editor/inspector_plugins.html</link> </tutorials> <methods> <method name="_can_handle" qualifiers="virtual"> @@ -56,7 +57,7 @@ <return type="void" /> <argument index="0" name="control" type="Control" /> <description> - Adds a custom control, not necessarily a property editor. + Adds a custom control, which is not necessarily a property editor. </description> </method> <method name="add_property_editor"> @@ -64,7 +65,7 @@ <argument index="0" name="property" type="String" /> <argument index="1" name="editor" type="Control" /> <description> - Adds a property editor, this must inherit [EditorProperty]. + Adds a property editor for an individual property. The [code]editor[/code] control must extend [EditorProperty]. </description> </method> <method name="add_property_editor_for_multiple_properties"> @@ -73,7 +74,7 @@ <argument index="1" name="properties" type="PackedStringArray" /> <argument index="2" name="editor" type="Control" /> <description> - Adds an editor that allows modifying multiple properties, this must inherit [EditorProperty]. + Adds an editor that allows modifying multiple properties. The [code]editor[/code] control must extend [EditorProperty]. </description> </method> </methods> diff --git a/doc/classes/EditorProperty.xml b/doc/classes/EditorProperty.xml index 41f42568ad..725b0ba8ff 100644 --- a/doc/classes/EditorProperty.xml +++ b/doc/classes/EditorProperty.xml @@ -47,14 +47,14 @@ <method name="get_tooltip_text" qualifiers="const"> <return type="String" /> <description> - Override if you want to allow a custom tooltip over your property. + Must be implemented to provide a custom tooltip to the property editor. </description> </method> <method name="set_bottom_editor"> <return type="void" /> <argument index="0" name="editor" type="Control" /> <description> - Adds controls with this function if you want them on the bottom (below the label). + Puts the [code]editor[/code] control below the property label. The control must be previously added using [method Node.add_child]. </description> </method> </methods> |