[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [RFC 08/10] docs: Add kernel-doc API documentation to memor
From: |
Peter Maydell |
Subject: |
[Qemu-devel] [RFC 08/10] docs: Add kernel-doc API documentation to memory.rst |
Date: |
Tue, 21 May 2019 13:25:17 +0100 |
Add the API documentation as generated by kernel-doc to memory.rst.
Signed-off-by: Peter Maydell <address@hidden>
---
Note that this generates errors that break the build, at
least with the 1.7.5 version of Sphinx I'm currently using.
---
docs/devel/memory.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/devel/memory.rst b/docs/devel/memory.rst
index b6a4c37ea5e..68bc6202797 100644
--- a/docs/devel/memory.rst
+++ b/docs/devel/memory.rst
@@ -361,3 +361,8 @@ callbacks are called:
- .impl.unaligned specifies that the *implementation* supports unaligned
accesses; if false, unaligned accesses will be emulated by two aligned
accesses.
+
+Detailed API documentation
+--------------------------
+
+.. kernel-doc:: include/exec/memory.h
--
2.20.1
- [Qemu-devel] [RFC 00/10] Add kernel-doc support to our Sphinx setup, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 03/10] docs/conf.py: Enable use of kerneldoc sphinx extension, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 04/10] docs/conf.py: Ignore some missing references in nitpick mode, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 05/10] bitops.h: Silence kernel-doc complaints, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 02/10] docs: Add kerneldoc sphinx module from Linux, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 10/10] Makefile: disable Sphinx nitpicking, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 07/10] memory.h: Fix kerneldoc syntax issues, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 08/10] docs: Add kernel-doc API documentation to memory.rst,
Peter Maydell <=
- [Qemu-devel] [RFC 09/10] memory.h: attempted kernel-doc fixes, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 06/10] docs: Create bitops.rst as example of kernel-docs, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 01/10] scripts/kernel-doc: Import kernel-doc script from Linux, Peter Maydell, 2019/05/21
- Re: [Qemu-devel] [RFC 00/10] Add kernel-doc support to our Sphinx setup, Peter Maydell, 2019/05/21
- Re: [Qemu-devel] [RFC 00/10] Add kernel-doc support to our Sphinx setup, no-reply, 2019/05/21