qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 4/5] docs/devel: split qom-api reference into new file


From: Philippe Mathieu-Daudé
Subject: Re: [PATCH 4/5] docs/devel: split qom-api reference into new file
Date: Tue, 20 Jun 2023 12:22:26 +0200
User-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:102.0) Gecko/20100101 Thunderbird/102.12.0

On 20/6/23 12:03, Richard Henderson wrote:
On 6/19/23 19:14, Alex Bennée wrote:
+We don't currently generate the API documentation for QDEV due to QEMU
+macros confusing the kerneldoc tool. For now see the headers in
+``include/hw/qdev-core.h``
+
+..
+  kernel-doc:: include/hw/qdev-core.h

I'm confused.  Isn't that exactly what you're doing here?

IIUC the kernel-doc style comments from "hw/qdev-core.h"
are embedded as rST doc, see:
https://kernel.readthedocs.io/en/sphinx-samples/kernel-documentation.html#including-kernel-doc-comments




reply via email to

[Prev in Thread] Current Thread [Next in Thread]