On 5/20/19 2:41 PM, Eduardo Habkost wrote:
> Please welcome GSoC student Gabriel Barreto. Gabriel is going to
> work on QEMU API Documentation Generation[1].
>
> Gabriel's first task is to evaluate our options for extract doc
> comments from C source code and integrate them into Sphinx
> documentation. I saw that Peter has experimented with kernel-doc
> in the past[2][3]. Has anybody evaluated other alternatives?
> (e.g. Hawkmoth[4])
>
> [1]
> https://wiki.qemu.org/Google_Summer_of_Code_2019#API_documentation_generation
> [2] https://www.mail-archive.com/qemu-devel@nongnu.org/msg411643.html
> [3] https://www.mail-archive.com/qemu-devel@nongnu.org/msg411841.html
> [4] https://readthedocs.org/projects/hawkmoth/
>
Gabriel, welcome! This has been something that has been bothering me a
LOT lately and I hope we'll be able to work together to improve the
state of things.
Please let us know if you need any help.
--js
