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

Generate SDK Documentation with Doxygen Instead of Headerdoc #139

Open
njsch opened this issue Dec 15, 2020 · 0 comments
Open

Generate SDK Documentation with Doxygen Instead of Headerdoc #139

njsch opened this issue Dec 15, 2020 · 0 comments

Comments

@njsch
Copy link
Contributor

njsch commented Dec 15, 2020

Currently it only seems possible to test Headerdoc-generated content on Mac and possibly Linux. Windows could be included in these checks if Doxygen was used instead.

Additionally, I'm also not sure whether Headerdoc may even be one of Apple's legacy projects. I was wondering if it would be more efficient to have something more universally cross-platform and potentially not deprecated.

It does not appear that it would require too much work in terms of modifications to dev docs found in the SK-core code. But I haven't really looked into this much yet, it's just a thought that occurred when three out of four checks failed on some code I have written.

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

No branches or pull requests

1 participant