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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Tue, 3 Feb 2015, Bjørn Mork wrote:

> "Robert P. J. Day" <rpjday@xxxxxxxxxxxxxx> 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.

  ah, good point, i had totally missed that. i'll move this discussion
to the linux-doc list and resolve it there.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================
_______________________________________________
Kernelnewbies mailing list
Kernelnewbies@xxxxxxxxxxxxxxxxx
http://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies

[Index of Archives]     [Newbies FAQ]     [Linux Kernel Mentors]     [Linux Kernel Development]     [IETF Annouce]     [Git]     [Networking]     [Security]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux SCSI]     [Linux ACPI]
  Powered by Linux