tutorials/scripting/gdscript/gdscript_documentation_comments

[giscus[bot]]

tutorials/scripting/gdscript/gdscript_documentation_comments

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 d...

https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_documentation_comments.html

[elementbound]

Even though Error is an enum, you can link to its values as [constant OK].

[Calinou]

Enum values are referred to with [constant], so that makes sense 🙂

[enum] is used to refer to the enum itself instead, e.g. [enum Error].

(OK is an Error value despite not starting with ERR.)

[elementbound]

Not arguing against this behavior, just made a note so I don't forget 😄 And maybe spare others some pondering.

[Cykyrios]

Is it a known issue that referencing enum values with [constant SomeClass.SomeEnum.SOME_VALUE] doesn't work properly? It does format the text as a link, but it does not actually link to the expected target, the link is broken.

[Calinou]

@Cykyrios Please open an issue on https://github.com/godotengine/godot/issues with a minimal reproduction project attached.

[Cykyrios]

I did shortly after posting here, probably should've done that directly - see #106828.

[3ter]

I needed to change something in the .gd file of the respective class for it to appear when searching the help (e.g. with F1) (even if immediately changed back, this worked for me).

[Zehir]

It's related to this issue : godotengine/godot#72406

Until it's resolved you can put a small plugin to load and save the script that force the help recompilation;

@tool
extends EditorPlugin
func _ready() -> void:
	ResourceSaver.save(preload("hexagon_tilemaplayer.gd"))

This issue will be fixed in 4.5

[NikPratr]

Does the [class] syntax not work for user defined classes?

[endgrant]

I'm also having this issue. I cannot get my custom classes to format the way built-in ones can when writing my documentation.