seccomp / libseccomp

The main libseccomp repository
GNU Lesser General Public License v2.1
794 stars 171 forks source link

RFE: Add Doxygen Github Pages #366

Open drakenclimber opened 2 years ago

drakenclimber commented 2 years ago

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:

drakenclimber commented 2 years ago

This could close issue #195

coveralls commented 2 years ago

Coverage Status

Coverage remained the same at 89.601% when pulling f2548f2fb21d8e2274c372eb48deb6a6f9f134d8 on drakenclimber:issues/doxygen into 51b50f95e1fb717e4560818f8b90b7ebde314ad1 on seccomp:main.

drakenclimber commented 2 years ago

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 :)

pcmoore commented 2 years ago

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:

pcmoore commented 8 months ago

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.