bpf.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Grant Seltzer Richman <grantseltzer@gmail.com>
To: bpf <bpf@vger.kernel.org>
Subject: Generating libbpf API documentation
Date: Mon, 15 Mar 2021 12:50:02 -0400	[thread overview]
Message-ID: <CAO658oXG4HEm0rGEW-==0kaTmqenDUC_GM-qi7CEjwSakbnJRw@mail.gmail.com> (raw)

Hi all,

I have been experimenting with ways to contribute documentation to
libbpf to make it easier for developers of bpf projects to use it.
With the goal of making a documentation site that is easy to
maintain/generate I found Doxygen (many of you may have experience
with it, I did not). I set up a CI/CD workflow using github actions
that runs doxygen on the libbpf mirror hosted there, and hosts the
produced HTML using netlify. You can find the currently hosted version
of it at https://libbpf-docs.netlify.app (I would gladly donate a real
domain name for this purpose). The docs generation workflow is in my
github repo here: https://github.com/grantseltzer/libbpf-docs

In order to make this work all we would need is to format comments
above functions we want to document. Doxygen requires that the comment
just be in a block that starts with `/**`. I don't think doxygen
specific directives should be committed to code but I think this is a
fine convention to follow. Other doxygen directives (i.e. having
`@file` in every file) can be faked using a step I have in the github
actions.

What does everyone think? Can we agree on this convention and start
contributing documentation in this way? Any pitfalls to doxygen I'm
not familiar with?

Thanks!

             reply	other threads:[~2021-03-15 16:51 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-15 16:50 Grant Seltzer Richman [this message]
2021-03-16  0:47 ` Generating libbpf API documentation Andrii Nakryiko
2021-03-16 20:14   ` Grant Seltzer Richman
2021-04-16 19:38     ` Grant Seltzer Richman
2021-04-20  4:26       ` Andrii Nakryiko
2021-04-21 19:24         ` Grant Seltzer Richman
2021-04-22  3:58           ` Andrii Nakryiko
2021-04-22 21:20             ` Grant Seltzer Richman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAO658oXG4HEm0rGEW-==0kaTmqenDUC_GM-qi7CEjwSakbnJRw@mail.gmail.com' \
    --to=grantseltzer@gmail.com \
    --cc=bpf@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).