浏览代码

Merge pull request #51329 from pycbouh/docs-inspector-plugins-classref-3.x

[3.x] Improve the inspector plugin documentation and remove a confusing statement
Rémi Verschelde 4 年之前
父节点
当前提交
92fa4e137d
共有 2 个文件被更改,包括 6 次插入5 次删除
  1. 4 3
      doc/classes/EditorInspectorPlugin.xml
  2. 2 2
      doc/classes/EditorProperty.xml

+ 4 - 3
doc/classes/EditorInspectorPlugin.xml

@@ -13,13 +13,14 @@
 		On each of these calls, the "add" functions can be called.
 	</description>
 	<tutorials>
+		<link title="Inspector plugins">https://docs.godotengine.org/en/3.3/tutorials/plugins/editor/inspector_plugins.html</link>
 	</tutorials>
 	<methods>
 		<method name="add_custom_control">
 			<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">
@@ -27,7 +28,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">
@@ -36,7 +37,7 @@
 			<argument index="1" name="properties" type="PoolStringArray" />
 			<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>
 		<method name="can_handle" qualifiers="virtual">

+ 2 - 2
doc/classes/EditorProperty.xml

@@ -41,14 +41,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>
 		<method name="update_property" qualifiers="virtual">