From 27e9df7778f9546739787caa9335636a01314877 Mon Sep 17 00:00:00 2001 From: Nick Huelin <62965063+SirQuartz@users.noreply.github.com> Date: Tue, 6 Jul 2021 07:22:53 -0400 Subject: [PATCH] Add multiple descriptions to several classes This pull request adds several descriptions to multiple different classes. This improves the completeness of the documentation and enhances usability by doing so. --- doc/classes/EditorPlugin.xml | 2 ++ doc/classes/LineEdit.xml | 1 + doc/classes/Popup.xml | 1 + doc/classes/TextEdit.xml | 5 +++++ doc/classes/Tree.xml | 1 + 5 files changed, 10 insertions(+) diff --git a/doc/classes/EditorPlugin.xml b/doc/classes/EditorPlugin.xml index a02d318f70e..753227513b0 100644 --- a/doc/classes/EditorPlugin.xml +++ b/doc/classes/EditorPlugin.xml @@ -547,6 +547,7 @@ + Minimizes the bottom panel. @@ -555,6 +556,7 @@ + Makes a specific item in the bottom panel visible. diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index f1e7c5f6e17..38f31e44c98 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -169,6 +169,7 @@ The caret's column position inside the [LineEdit]. When set, the text may scroll to accommodate it. + If [code]true[/code], the [LineEdit] will always show the caret, even if focus is lost. Allow moving caret, selecting and removing the individual composite character components. diff --git a/doc/classes/Popup.xml b/doc/classes/Popup.xml index b8d8a554129..89695989c83 100644 --- a/doc/classes/Popup.xml +++ b/doc/classes/Popup.xml @@ -13,6 +13,7 @@ + If [code]true[/code], the [Popup] will close when its parent is focused. diff --git a/doc/classes/TextEdit.xml b/doc/classes/TextEdit.xml index 6a3c124c60c..5de6c059c34 100644 --- a/doc/classes/TextEdit.xml +++ b/doc/classes/TextEdit.xml @@ -14,6 +14,7 @@ + A virtual method that is called whenever backspace is triggered. @@ -28,6 +29,7 @@ + Causes the [TextEdit] to perform a backspace. @@ -172,6 +174,7 @@ + Returns the indent level of a specific line. @@ -312,6 +315,7 @@ + Returns the [TextEdit]'s' tab size. @@ -667,6 +671,7 @@ + Sets the tab size for the [TextEdit] to use. diff --git a/doc/classes/Tree.xml b/doc/classes/Tree.xml index b20c6f334f1..b498b9bb900 100644 --- a/doc/classes/Tree.xml +++ b/doc/classes/Tree.xml @@ -294,6 +294,7 @@ + Causes the [Tree] to jump to the specified item.