[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [RFC 09/10] memory.h: attempted kernel-doc fixes
From: |
Peter Maydell |
Subject: |
[Qemu-devel] [RFC 09/10] memory.h: attempted kernel-doc fixes |
Date: |
Tue, 21 May 2019 13:25:18 +0100 |
kernel-doc needs the "struct" or it complains that it
can't parse a function prototype which is actually a struct
definition.
Note that this then creates a lot of warnings about
undocumented struct fields...
---
include/exec/memory.h | 22 ++++++++++++----------
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/include/exec/memory.h b/include/exec/memory.h
index 8447a16ded1..d0f35be1c3b 100644
--- a/include/exec/memory.h
+++ b/include/exec/memory.h
@@ -208,7 +208,7 @@ enum IOMMUMemoryRegionAttr {
};
/**
- * IOMMUMemoryRegionClass:
+ * struct IOMMUMemoryRegionClass:
*
* All IOMMU implementations need to subclass TYPE_IOMMU_MEMORY_REGION
* and provide an implementation of at least the @translate method here
@@ -224,8 +224,10 @@ enum IOMMUMemoryRegionAttr {
* attributes and the output TLB entry depends on the transaction
* attributes, we represent this using IOMMU indexes. Each index
* selects a particular translation table that the IOMMU has:
- * @attrs_to_index returns the IOMMU index for a set of transaction
attributes
- * @translate takes an input address and an IOMMU index
+ *
+ * - @attrs_to_index returns the IOMMU index for a set of transaction
attributes
+ * - @translate takes an input address and an IOMMU index
+ *
* and the mapping returned can only depend on the input address and the
* IOMMU index.
*
@@ -398,7 +400,7 @@ struct IOMMUMemoryRegion {
QLIST_FOREACH((n), &(mr)->iommu_notify, node)
/**
- * MemoryListener: callbacks structure for updates to the physical memory map
+ * struct MemoryListener: callbacks structure for updates to the physical
memory map
*
* Allows a component to adjust to changes in the guest-visible memory map.
* Use with memory_listener_register() and memory_listener_unregister().
@@ -432,7 +434,7 @@ struct MemoryListener {
};
/**
- * AddressSpace: describes a mapping of addresses to #MemoryRegion objects
+ * struct AddressSpace: describes a mapping of addresses to #MemoryRegion
objects
*/
struct AddressSpace {
/* All fields are private. */
@@ -472,7 +474,7 @@ static inline FlatView
*address_space_to_flatview(AddressSpace *as)
/**
- * MemoryRegionSection: describes a fragment of a #MemoryRegion
+ * struct MemoryRegionSection: describes a fragment of a #MemoryRegion
*
* @mr: the region, or %NULL if empty
* @fv: the flat view of the address space the region is mapped in
@@ -1653,8 +1655,8 @@ bool memory_region_is_mapped(MemoryRegion *mr);
* Returns a #MemoryRegionSection that describes a contiguous overlap.
* It will have the following characteristics:
*
- * address@hidden = 0 iff no overlap was found
- * address@hidden is non-%NULL iff an overlap was found
+ * - address@hidden = 0 iff no overlap was found
+ * - address@hidden is non-%NULL iff an overlap was found
*
* Remember that in the return value the @offset_within_region is
* relative to the returned region (in the address@hidden field), not to the
@@ -1666,8 +1668,8 @@ bool memory_region_is_mapped(MemoryRegion *mr);
* has no container (and thus is the root of the address space), the
* following will hold:
*
- * address@hidden >= @addr
- * address@hidden + address@hidden <= @addr + @size
+ * - address@hidden >= @addr
+ * - address@hidden + address@hidden <= @addr + @size
*
* @mr: a MemoryRegion within which @addr is a relative address
* @addr: start of the area within @as to be searched
--
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, 2019/05/21
- [Qemu-devel] [RFC 09/10] memory.h: attempted kernel-doc fixes,
Peter Maydell <=
- [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