Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GdScript documentation comments - enums always appear in the help window #84119

Closed
daveTheOldCoder opened this issue Oct 28, 2023 · 0 comments · Fixed by #84396
Closed

GdScript documentation comments - enums always appear in the help window #84119

daveTheOldCoder opened this issue Oct 28, 2023 · 0 comments · Fixed by #84396

Comments

@daveTheOldCoder
Copy link

daveTheOldCoder commented Oct 28, 2023

Godot version

v4.2.beta3.official [e8d57af]

System information

Godot v4.2.beta3 - Pop!_OS 20.04 LTS - X11 - Vulkan (Forward+) - integrated Intel(R) UHD Graphics 630 (CFL GT2) () - Intel(R) Core(TM) i9-9900K CPU @ 3.60GHz (16 Threads)

Issue description

An enum always appears in the help window, even if it is not preceded by documentation and its name starts with an underscore .

This is not consistent with the behavior of other items.

# The below function isn't documented and its name starts with an underscore
# so it will treated as private and will not be shown in the help window.
func _internal() -> void:
	pass

Reference for GdScript documentation comments:
https://docs.godotengine.org/en/4.1/tutorials/scripting/gdscript/gdscript_documentation_comments.html

Steps to reproduce

Create a script test.gd with contents:

enum _A {B, C}

Press the F1 key or click the Search Help icon, and type the name of the file.

Minimal reproduction project

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants