godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-03 05:48:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

minor grammar and typo in gdscript_documentation_comments.rst

Browse Source
This commit is contained in:
Cameron
2023-04-30 10:47:39 -07:00
committed by GitHub
parent 332399538b
commit da69035b1c
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
tutorials/scripting/gdscript/gdscript_documentation_comments.rst
View File

@@ -3,7 +3,7 @@
GDScript documentation comments
===============================
In GDScript, comments can be used to document your code and add description to the
In GDScript, comments can be used to document your code and add descriptions to the
members of a script. There are two differences between a normal comment and a documentation
comment. Firstly, a documentation comment should start with double hash symbols
``##``. Secondly, it must immediately precede a script member, or for script descriptions,
@@ -22,8 +22,8 @@ suggested format for script documentation can be divided into three parts.
- Tutorials.
To separate these from each other, the documentation comments use special tags.
The tag must be at the beginning of a line (ignoring preceding white space) and has
the format ``@``, followed by the keyword and finishing with a colon.
The tag must be at the beginning of a line (ignoring preceding white space) and must
have the format ``@``, followed by the keyword, and finishing with a colon.
Tags
~~~~
@@ -69,10 +69,10 @@ The description can have more than one line but every line must start
with the double hash symbol ``##`` to be considered as part of the documentation.
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. It will not appear in the documentation and
underscore, it will be treated as private. It will not appear in the documentation and
will be ignored in the help window.
Members that are applicable for the documentation:
Members that are applicable for documentation:
- Inner class
- Constant
@@ -137,7 +137,7 @@ Examples
## Documenting an inner class.
##
## The same rules apply apply here. The documentation must
## The same rules apply here. The documentation must
## immediately precede the class definition.
##
## @tutorial: https://the/tutorial/url.com