Open drakenclimber opened 2 years ago
This could close issue #195
Really just that one question regarding hiding the
API
macro, but I'm good with this either way. I'll refrain from merging this due to that question, but if there is no good answer go ahead and merge it @drakenclimber.
I would really prefer to resolve the question over the API
stuff before we merge it. The only thing worse than missing documentation is wrong/misleading documentation :)
I would really prefer to resolve the question over the
API
stuff before we merge it. The only thing worse than missing documentation is wrong/misleading documentation :)
Fair enough :)
FWIW, I found these suggestions while quickly googling the issue:
In an effort to get v2.6.0 out sooner than later, I'm going to suggest we push this out to v2.7.0; if you have any concerns or objections please drop a comment.
This patchset automatically generates Doxygen documentation and writes it to a github branch. Github supports a feature called pages where a branch is displayed as HTML, and I'm using that to then render the Doxygen output.
Here's what it looks like on my personal libseccomp repo: https://drakenclimber.github.io/libseccomp/index.html
A couple more comments:
main
branch. If we wanted to generate Doxygen for the release branches as well, we could publish each branch to a subfolder. Then we could make a simple index pageseccomp.h.in
so that the start page isn't empty. Definitely room for improvement here