From 0c92c92891109777cd9622e112451a38f87a24d5 Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Mon, 20 Feb 2023 11:18:57 +0800 Subject: [PATCH] Various classref typo fixes --- doc/classes/CodeEdit.xml | 4 ++-- doc/classes/CodeHighlighter.xml | 2 +- doc/classes/DisplayServer.xml | 2 +- doc/classes/EditorSettings.xml | 2 +- doc/classes/FileAccess.xml | 2 +- doc/classes/Light2D.xml | 2 +- doc/classes/MenuBar.xml | 2 +- doc/classes/PackedByteArray.xml | 4 ++-- doc/classes/StyleBoxFlat.xml | 2 +- doc/classes/StyleBoxTexture.xml | 2 +- doc/classes/TextServer.xml | 2 +- 11 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/classes/CodeEdit.xml b/doc/classes/CodeEdit.xml index 1bc214aea73..65a6668f430 100644 --- a/doc/classes/CodeEdit.xml +++ b/doc/classes/CodeEdit.xml @@ -62,7 +62,7 @@ Adds a comment delimiter. Both the start and end keys must be symbols. Only the start key has to be unique. - Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. @@ -73,7 +73,7 @@ Adds a string delimiter. Both the start and end keys must be symbols. Only the start key has to be unique. - Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. diff --git a/doc/classes/CodeHighlighter.xml b/doc/classes/CodeHighlighter.xml index fd1f595fc62..eedd4c17697 100644 --- a/doc/classes/CodeHighlighter.xml +++ b/doc/classes/CodeHighlighter.xml @@ -18,7 +18,7 @@ Adds a color region such as comments or strings. Both the start and end keys must be symbols. Only the start key has to be unique. - Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. + [param line_only] denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to [code]true[/code]. diff --git a/doc/classes/DisplayServer.xml b/doc/classes/DisplayServer.xml index 122db7e6683..79c876b30b2 100644 --- a/doc/classes/DisplayServer.xml +++ b/doc/classes/DisplayServer.xml @@ -1677,7 +1677,7 @@ Minimized window mode, i.e. [Window] is not visible and available on window manager's window list. Normally happens when the minimize button is pressed. - Maximized window mode, i.e. [Window] will occupy whole screen area except task bar and still display its borders. Normally happens when the minimize button is pressed. + Maximized window mode, i.e. [Window] will occupy whole screen area except task bar and still display its borders. Normally happens when the maximize button is pressed. Full screen mode with full multi-window support. diff --git a/doc/classes/EditorSettings.xml b/doc/classes/EditorSettings.xml index 1bf8cbf1755..70ea69a3363 100644 --- a/doc/classes/EditorSettings.xml +++ b/doc/classes/EditorSettings.xml @@ -196,7 +196,7 @@ The thumbnail size to use in the FileSystem dock (in pixels). See also [member filesystem/file_dialog/thumbnail_size]. - The refresh interval to use for the Inspector dock's properties. The effect of this setting is mainly noticeable when adjusting gizmos in the 2D/3D editor and looking at the inspector at the same time. Lower values make the inspector more often, but take up more CPU time. + The refresh interval to use for the Inspector dock's properties. The effect of this setting is mainly noticeable when adjusting gizmos in the 2D/3D editor and looking at the inspector at the same time. Lower values make the inspector refresh more often, but take up more CPU time. The tint intensity to use for the subresources background in the Inspector dock. The tint is used to distinguish between different subresources in the inspector. Higher values result in a more noticeable background color difference. diff --git a/doc/classes/FileAccess.xml b/doc/classes/FileAccess.xml index 526f7c22e6e..c85bde681f0 100644 --- a/doc/classes/FileAccess.xml +++ b/doc/classes/FileAccess.xml @@ -55,7 +55,7 @@ - Closes the currently opened file and prevents subsequent read/write operations. Use flush to persist the data to disk without closing the file. + Closes the currently opened file and prevents subsequent read/write operations. Use [method flush] to persist the data to disk without closing the file. [b]Note:[/b] [FileAccess] will automatically close when it's freed, which happens when it goes out of scope or when it gets assigned with [code]null[/code]. In C# the reference must be disposed after we are done using it, this can be done with the [code]using[/code] statement or calling the [code]Dispose[/code] method directly. diff --git a/doc/classes/Light2D.xml b/doc/classes/Light2D.xml index 9f1b1af60d5..4481131f81a 100644 --- a/doc/classes/Light2D.xml +++ b/doc/classes/Light2D.xml @@ -80,7 +80,7 @@ Percentage closer filtering (5 samples) applies to the shadow map. This is slower compared to hard shadow rendering. See [member shadow_filter]. - Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtereing mode, and should be used sparingly. See [member shadow_filter]. + Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtering mode, and should be used sparingly. See [member shadow_filter]. Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light. diff --git a/doc/classes/MenuBar.xml b/doc/classes/MenuBar.xml index 79876e56a3a..fac5eae98cd 100644 --- a/doc/classes/MenuBar.xml +++ b/doc/classes/MenuBar.xml @@ -4,7 +4,7 @@ A horizontal menu bar, which displays [PopupMenu]s or system global menu. - New items can be created by adding [PopupMenu] nodes to his node. + New items can be created by adding [PopupMenu] nodes to this node. diff --git a/doc/classes/PackedByteArray.xml b/doc/classes/PackedByteArray.xml index ccf012f82c0..c079a70ae50 100644 --- a/doc/classes/PackedByteArray.xml +++ b/doc/classes/PackedByteArray.xml @@ -229,7 +229,7 @@ - Encodes a 32-bit signed integer number as bytes at the index of [param byte_offset] bytes. The array must have at least 2 bytes of space, starting at the offset. + Encodes a 32-bit signed integer number as bytes at the index of [param byte_offset] bytes. The array must have at least 4 bytes of space, starting at the offset. @@ -237,7 +237,7 @@ - Encodes a 64-bit signed integer number as bytes at the index of [param byte_offset] bytes. The array must have at least 2 bytes of space, starting at the offset. + Encodes a 64-bit signed integer number as bytes at the index of [param byte_offset] bytes. The array must have at least 8 bytes of space, starting at the offset. diff --git a/doc/classes/StyleBoxFlat.xml b/doc/classes/StyleBoxFlat.xml index d6900f935c2..6bcc3c5ea60 100644 --- a/doc/classes/StyleBoxFlat.xml +++ b/doc/classes/StyleBoxFlat.xml @@ -94,7 +94,7 @@ - Sets the expand margin to [param size] pixels for all margins. + Sets the expand margin to [param size] pixels for all sides. diff --git a/doc/classes/StyleBoxTexture.xml b/doc/classes/StyleBoxTexture.xml index f2f6e59a9e8..6a29bf38dba 100644 --- a/doc/classes/StyleBoxTexture.xml +++ b/doc/classes/StyleBoxTexture.xml @@ -35,7 +35,7 @@ - Sets the expand margin to [param size] pixels for all margins. + Sets the expand margin to [param size] pixels for all sides. diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml index 711fb89217b..ad37cf5c86e 100644 --- a/doc/classes/TextServer.xml +++ b/doc/classes/TextServer.xml @@ -12,7 +12,7 @@ - Creates new, empty font cache entry resource. To free the resulting resourec, use [method free_rid] method. + Creates new, empty font cache entry resource. To free the resulting resource, use [method free_rid] method.