mbox series

[0/5] kernel-doc ixes

Message ID 20201003024123.193840-1-ehabkost@redhat.com
Headers show
Series kernel-doc ixes | expand

Message

Eduardo Habkost Oct. 3, 2020, 2:41 a.m. UTC 
Among other fixes in kernel-doc, this series get rid of
QEMU-specific $decl_type='type name' hack in kernel-doc, because
it made it impossible to document macros with names starting with
uppercase letters (like most of the macros at qom/object.h).

Eduardo Habkost (5):
  kernel-doc: Handle function typedefs that return pointers
  kernel-doc: Handle function typedefs without asterisks
  qom: Explicitly tag doc comments for typedefs and structs
  memory: Explicitly tag doc comments for structs
  kernel-doc: Remove $decl_type='type name' hack

 include/exec/memory.h |  6 +++---
 include/qom/object.h  | 22 +++++++++++-----------
 scripts/kernel-doc    | 16 +++-------------
 3 files changed, 17 insertions(+), 27 deletions(-)

-- 
2.26.2

Comments

Paolo Bonzini Oct. 3, 2020, 8:59 a.m. UTC | #1 
On 03/10/20 04:41, Eduardo Habkost wrote:
> Among other fixes in kernel-doc, this series get rid of

> QEMU-specific $decl_type='type name' hack in kernel-doc, because

> it made it impossible to document macros with names starting with

> uppercase letters (like most of the macros at qom/object.h).


Thanks, it seemed like a good idea but... it wasn't. :)

Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>


Paolo

> Eduardo Habkost (5):

>   kernel-doc: Handle function typedefs that return pointers

>   kernel-doc: Handle function typedefs without asterisks

>   qom: Explicitly tag doc comments for typedefs and structs

>   memory: Explicitly tag doc comments for structs

>   kernel-doc: Remove $decl_type='type name' hack

> 

>  include/exec/memory.h |  6 +++---

>  include/qom/object.h  | 22 +++++++++++-----------

>  scripts/kernel-doc    | 16 +++-------------

>  3 files changed, 17 insertions(+), 27 deletions(-)

>