How to read (and write) Godot's Documentation
Channel: SDG Games
Date: 20/03/2024

Godot has an excellent built-in documentation feature. But, some people aren't used to documentation of any kind, so using this feature might be scary. This video tries to break down and explain the basic categories present in the Godot documentation.
I do this by writing the documentation for one of my own classes and comparing the generated docs to the code itself.

The source code for this file is here:
https://gitlab.com/20-games-in-30-days/survivors/-/blob/7e706a7626d8cdf5d859383dc46299911edba00c/Player/radar.gd

(The assets for this project are on the godot_docs_video branch, if you want to look at other files, here's the link to that one:)
https://gitlab.com/20-games-in-30-days/survivors/-/tree/godot_docs_video?ref_type=heads

Godot's editor icons are a part of the Godot source code, under /editor/icons. Here's a link:
https://github.com/godotengine/godot/tree/master/editor/icons

If you are writing documentation for yourself, check out the guide for [inline statements]:
https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_documentation_comments.html

00:00 Intro
01:51 Introducing our class
02:55 Dealing with icons
03:44 Generating customized docs for our class
05:06 Class descriptions and tutorials
06:56 What is a property?
08:45 Private vs Public
10:18 What is a method?
11:13 Is it a function, or a method?
12:04 Static methods
13:12 Setters and getters
15:30 Constants
16:22 Signals
17:45 Experimental and Deprecated flags
19:55 Enumerations
21:02 _init and constructors
22:37 Virtual methods
23:33 The bad ending

#godot #godot4 #godotengine 
Godot, Godot 4, Godot 4.2