Skip to contentSkip to conversation

memory: Remove kernel-doc comment marker

PATCH In review Eduardo Habkost 2 participants 2 messages Sep 8, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 memory: Remove kernel-doc comment marker

The IOMMUMemoryRegionClass struct documentation was never in the kernel-doc format. Stop pretending it is, by removing the "/**" comment marker.

This fixes a documentation build error introduced when we split the IOMMUMemoryRegionClass typedef from the struct declaration.

---
I will submit a separate patch to convert the documentation to kernel-doc format later. This is just a build fix that restores the previous behavior (IOMMUMemoryRegionClass was never included in the generated documentation).
---
Cc: Paolo Bonzini <[email protected]>
Cc: [email protected]

---
 include/exec/memory.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/exec/memory.h +1 -1
index dc908738c6..f1bb2a7df5 100644
@@ -211,7 +211,7 @@ enum IOMMUMemoryRegionAttr {
     IOMMU_ATTR_SPAPR_TCE_FD
 };
 
-/**
+/*
  * IOMMUMemoryRegionClass:
  *
  * All IOMMU implementations need to subclass TYPE_IOMMU_MEMORY_REGION
Signature · 1 line
2.26.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 9 lines · Eduardo Habkost

The IOMMUMemoryRegionClass struct documentation was never in the kernel-doc format. Stop pretending it is, by removing the "/**" comment marker.

This fixes a documentation build error introduced when we split the IOMMUMemoryRegionClass typedef from the struct declaration.

Quoted 26 lines

---
I will submit a separate patch to convert the documentation to kernel-doc format later. This is just a build fix that restores the previous behavior (IOMMUMemoryRegionClass was never included in the generated documentation).
---
Cc: Paolo Bonzini <[email protected]>
Cc: [email protected]

---
 include/exec/memory.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
include/exec/memory.h +1 -1
index dc908738c6..f1bb2a7df5 100644
@@ -211,7 +211,7 @@ enum IOMMUMemoryRegionAttr {
     IOMMU_ATTR_SPAPR_TCE_FD
 };
 
-/**
+/*
  * IOMMUMemoryRegionClass:
  *
  * All IOMMU implementations need to subclass TYPE_IOMMU_MEMORY_REGION