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

Document private methods #5

Open
KR155E opened this issue Dec 5, 2024 · 0 comments
Open

Document private methods #5

KR155E opened this issue Dec 5, 2024 · 0 comments

Comments

@KR155E
Copy link
Member

KR155E commented Dec 5, 2024

Apparently Doxygen only catches methods which are listed in the class definition header files. Thus, it's missing private methods and go-to-definition therefore is not working for those.

To solve that we'd have to add those methods to the header files, and decorate the section with /// @privatesection.

Since that would make them public, though, we need to rely on a workaround. Which is to add only comment blocks for the private methods and annotate which methods these are for.

An example can be found in https://github.com/VUEngine/VUEngine-Plugins/blob/f040a45f7050b687753516263df5e35790d71be6/other/LowPowerIndicator/source/LowPowerManager/LowPowerManager.h#L71

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

No branches or pull requests

1 participant