From 9aa85cee0588568690d2c0a842a0ac64588e63bc Mon Sep 17 00:00:00 2001 From: Danil Alexeev Date: Thu, 21 Sep 2023 16:23:31 +0300 Subject: [PATCH] Update "GDScript documentation comments" page --- .../gdscript_documentation_comments.rst | 24 +++++++++++-------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/tutorials/scripting/gdscript/gdscript_documentation_comments.rst b/tutorials/scripting/gdscript/gdscript_documentation_comments.rst index d621e4f52..b8d0eb7d5 100644 --- a/tutorials/scripting/gdscript/gdscript_documentation_comments.rst +++ b/tutorials/scripting/gdscript/gdscript_documentation_comments.rst @@ -100,20 +100,24 @@ For example:: ## @deprecated var my_var -Variables, constants, signals, and enum values support inline documentation comments. -Note that inline comments do not support tags. +Alternatively, you can use inline documentation comments:: -:: + enum MyEnum { ## My enum. + VALUE_A = 0, ## Value A. + VALUE_B = 1, ## Value B. + } + + const MY_CONST = 1 ## My constant. var my_var ## My variable. - const MY_CONST = 1 ## My constant. + signal my_signal ## My signal. - enum Direction { - UP = 0, ## Direction up. - DOWN = 1, ## Direction down. - LEFT = 2, ## Direction left. - RIGHT = 3, ## Direction right. - } + + func my_func(): ## My func. + pass + + class MyClass: ## My class. + pass The script documentation will update in the editor help window every time the script is updated. If any member variable or function name starts with an underscore, it will be treated as private.