[RFC,08/10] docs: Add kernel-doc API documentation to memory.rst

Message ID 20190521122519.12573-9-peter.maydell@linaro.org
State New
Headers show
Series
  • Add kernel-doc support to our Sphinx setup
Related show

Commit Message

Peter Maydell May 21, 2019, 12:25 p.m.
Add the API documentation as generated by kernel-doc to memory.rst.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

---
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(+)

-- 
2.20.1

Patch

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