diff mbox series

[8/8] docs: add memory API reference

Message ID 20191129140217.17797-9-pbonzini@redhat.com
State New
Headers show
Series docs: integrate doc comments with Sphinx build | expand

Commit Message

Paolo Bonzini Nov. 29, 2019, 2:02 p.m. UTC
Add kernel-doc directive to parse and include doc comments from
include/exec/memory.h.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 docs/devel/memory.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Peter Maydell Dec. 2, 2019, 6:05 p.m. UTC | #1
On Fri, 29 Nov 2019 at 14:02, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> Add kernel-doc directive to parse and include doc comments from
> include/exec/memory.h.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  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

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

thanks
-- PMM
diff mbox series

Patch

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