From 1b18fda613491968959976a6343ca6e7df30fbca Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Tue, 3 May 2022 16:00:51 +0800 Subject: [PATCH] Document RichTextLabel append_bbcode/parse_bbcode always return OK --- doc/classes/RichTextLabel.xml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 7be91ed0c..94d0d51e9 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -38,8 +38,9 @@ - Parses [code]bbcode[/code] and adds tags to the tag stack as needed. Returns the result of the parsing, [constant OK] if successful. + Parses [code]bbcode[/code] and adds tags to the tag stack as needed. [b]Note:[/b] Using this method, you can't close a tag that was opened in a previous [method append_bbcode] call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the [member bbcode_text] instead of using [method append_bbcode]. + [b]Note:[/b] This method internals' can't possibly fail, but an error code is returned for backwards compatibility, which will always be [constant OK]. @@ -108,7 +109,8 @@ - The assignment version of [method append_bbcode]. Clears the tag stack and inserts the new content. Returns [constant OK] if parses [code]bbcode[/code] successfully. + The assignment version of [method append_bbcode]. Clears the tag stack and inserts the new content. + [b]Note:[/b] This method internals' can't possibly fail, but an error code is returned for backwards compatibility, which will always be [constant OK].