Skip to content
  • Paolo Bonzini's avatar
    4cf41794
    docs: tweak kernel-doc for QEMU coding standards · 4cf41794
    Paolo Bonzini authored
    
    
    Surprisingly, QEMU does have a pretty consistent doc comment style and
    it is not very different from the Linux kernel's.  Of the documentation
    "sigils", only "#" separates the QEMU doc comment style from Linux's,
    and it has 200+ instances vs. 6 for the kernel's '&struct foo' (all in
    accel/tcg/translate-all.c), so it's clear that the two standards are
    different in this respect.  In addition, our structs are typedefed and
    recognized by CamelCase names.
    
    Adjust kernel-doc's parser for these two aspects of the QEMU coding
    standards.  The patch has been valid, with hardly any change, for over
    two years, so it should not be an issue to keep kernel-doc in sync with
    the Linux copy.
    
    Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
    4cf41794
    docs: tweak kernel-doc for QEMU coding standards
    Paolo Bonzini authored
    
    
    Surprisingly, QEMU does have a pretty consistent doc comment style and
    it is not very different from the Linux kernel's.  Of the documentation
    "sigils", only "#" separates the QEMU doc comment style from Linux's,
    and it has 200+ instances vs. 6 for the kernel's '&struct foo' (all in
    accel/tcg/translate-all.c), so it's clear that the two standards are
    different in this respect.  In addition, our structs are typedefed and
    recognized by CamelCase names.
    
    Adjust kernel-doc's parser for these two aspects of the QEMU coding
    standards.  The patch has been valid, with hardly any change, for over
    two years, so it should not be an issue to keep kernel-doc in sync with
    the Linux copy.
    
    Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
Loading