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

[4.0] GDScript custom class documentation doesn't mention name of setter / getter methods #68317

Open
ClarkThyLord opened this issue Nov 6, 2022 · 0 comments · May be fixed by #80765
Open

Comments

@ClarkThyLord
Copy link
Contributor

Godot version

Godot 4.0 beta 4

System information

Windows 10

Issue description

When GDScript generates documentation for the getter / setter of custom class properties it doesn't mention the name of the existing class functions if used by the getter / setter, as seen below:

image image

This is not inline with the way built-in class documentation is, as seen below:

image

I'm not too sure, but I'm inclined to believe that this was designed on purpose with the idea in mind that the getter / setter will be a code block (i.e. having no method name), but this fails to account for the use of existing class functions. Meaning that if I wanted to know the name of the getter / setter method I'd have to search for them in the source directly, which is not preferred.

Steps to reproduce

  1. Open example project
  2. Open documentation for "CustomClass"
  3. No mention of getter / setter method name for custom_property_a property

Minimal reproduction project

example.zip

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.

2 participants