[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 5/6] docs: add memory API reference
From: |
Paolo Bonzini |
Subject: |
[PATCH 5/6] docs: add memory API reference |
Date: |
Tue, 29 Oct 2019 17:22:47 +0100 |
Add kernel-doc directive to parse and include doc comments from
include/exec/memory.h.
Signed-off-by: Paolo Bonzini <address@hidden>
---
docs/devel/memory.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/devel/memory.rst b/docs/devel/memory.rst
index b6a4c37ea5..5dc8a12682 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.
+
+API Reference
+-------------
+
+.. kernel-doc:: include/exec/memory.h
--
2.21.0
- [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, Paolo Bonzini, 2019/10/29
- [PATCH 2/6] docs: tweak kernel-doc for QEMU coding standards, Paolo Bonzini, 2019/10/29
- [PATCH 5/6] docs: add memory API reference,
Paolo Bonzini <=
- [PATCH 4/6] memory: adjust API documentation to (modified) kerneldoc format, Paolo Bonzini, 2019/10/29
- [PATCH 3/6] docs: disable sphinx warning about missing cross references, Paolo Bonzini, 2019/10/29
- [PATCH 6/6] memory: include MemoryListener documentation and some missing function parameters, Paolo Bonzini, 2019/10/29
- [PATCH 1/6] docs: import Linux kernel-doc script and extension, Paolo Bonzini, 2019/10/29
- Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, no-reply, 2019/10/29
- Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, Peter Maydell, 2019/10/29