why is "const u32 (*tab)[256]" not kerneldoc-able?

Bjørn Mork bjorn at mork.no
Tue Feb 3 09:46:13 EST 2015


"Robert P. J. Day" <rpjday at crashcourse.ca> writes:

>   actually, i just found where this is a known issue:
>
> http://www.spinics.net/lists/linux-doc/msg09364.html

Probably because it's a rare construct.

But looking closer at this, trying to understand why the simple test
using

  scripts/kernel-doc lib/crc32.c |man -l -

seemed to sort of work, I found that your main problem isn't really the
lack of kernel-doc support for array pointer parameters.  It's a simple
mismatch between the documented and the exported functions.

scripts/docproc will only generate docs for exported symbols.
lib/crc32.c has no documented *and* exported functions, and thats why
the output is empty.  The array pointer is a red herring.


Bjørn



More information about the Kernelnewbies mailing list