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

possible fix for missing jsdoc #1226

Merged
merged 1 commit into from
Nov 28, 2024
Merged

Conversation

HifiExperiments
Copy link
Member

No description provided.

@HifiExperiments HifiExperiments added bug Something isn't working documentation Improvements or additions to documentation fix before release labels Nov 8, 2024
@daleglass
Copy link
Contributor

.in files look like something that's first pre-processed by something else to generate the real .h, so I believe a better fix would be to ensure jsdoc runs after that's done, and picks up the final, generated file

@HifiExperiments
Copy link
Member Author

they’re processed by cmake, does jsdoc usually require running cmake?

@HifiExperiments
Copy link
Member Author

it does not: https://github.com/overte-org/overte/blob/master/tools/jsdoc/README.md

an alternative fix would be to move the jsdoc to only be in actual .cpp/.h files, but that seems risky since other folks in the future could make the same mistake

Copy link
Member

@ksuprynowicz ksuprynowicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good :)

@ksuprynowicz
Copy link
Member

I tested it, and everything works properly, for example haze properties which are documented in .h.in file show up.

@ksuprynowicz ksuprynowicz merged commit eefeaf3 into overte-org:master Nov 28, 2024
7 checks passed
@HifiExperiments HifiExperiments deleted the jsdoc branch November 28, 2024 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation fix before release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants