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

HIde undocumented setters and getters from public API #6652

Closed
mvaligursky opened this issue Jun 3, 2024 · 6 comments · Fixed by #6685
Closed

HIde undocumented setters and getters from public API #6652

mvaligursky opened this issue Jun 3, 2024 · 6 comments · Fixed by #6685
Labels
bug docs Documentation related

Comments

@mvaligursky
Copy link
Contributor

It seems those are currently visible as public API. Example in the CameraComponent:

https://api.playcanvas.com/classes/Engine.CameraComponent.html#renderSceneColorMap

check the code it links .. there is no JSDocs block, but it's still exposed as public on the docs.

Screenshot 2024-06-03 at 15 39 57

@mvaligursky mvaligursky added bug docs Documentation related labels Jun 3, 2024
@LeXXik
Copy link
Contributor

LeXXik commented Jun 3, 2024

Should they go under Private or be completely hidden?
image

@mvaligursky
Copy link
Contributor Author

yep, they should be under private. The question is why are they public.

@willeastcott
Copy link
Contributor

@LeXXik
Copy link
Contributor

LeXXik commented Jun 3, 2024

Pretty sure if you remove the docs from the property and add to accessor with private tag, it should do it. Let me try.

@LeXXik LeXXik mentioned this issue Jun 3, 2024
@LeXXik
Copy link
Contributor

LeXXik commented Jun 3, 2024

Something like this, perhaps?

@willeastcott
Copy link
Contributor

@LeXXik I believe I have now addressed this in #6685. Check it out. 😄

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

Successfully merging a pull request may close this issue.

3 participants