From mboxrd@z Thu Jan 1 00:00:00 1970 From: bjorn@mork.no (=?utf-8?Q?Bj=C3=B8rn_Mork?=) Date: Tue, 03 Feb 2015 14:18:34 +0100 Subject: why is "const u32 (*tab)[256]" not kerneldoc-able? In-Reply-To: (Robert P. J. Day's message of "Tue, 3 Feb 2015 07:19:22 -0500 (EST)") References: Message-ID: <87fvanuo9h.fsf@nemi.mork.no> To: kernelnewbies@lists.kernelnewbies.org List-Id: kernelnewbies.lists.kernelnewbies.org "Robert P. J. Day" writes: > when generating the kerneldoc manual kernel-api.html with "make > htmldocs", the two routines in lib/crc32.c that refer to a parameter > of type "const u32 (*tab)[256]" generate kerneldoc errors: > > Warning(.//lib/crc32.c:148): No description found for parameter 'tab)[256]' > Warning(.//lib/crc32.c:148): Excess function parameter 'tab' description in 'crc32_le_generic' > Warning(.//lib/crc32.c:293): No description found for parameter 'tab)[256]' > Warning(.//lib/crc32.c:293): Excess function parameter 'tab' description in 'crc32_be_generic' > Warning(.//lib/crc32.c): no structured comments found > > kerneldoc content and declaration for one of them: > > /** > * crc32_le_generic() - Calculate bitwise little-endian Ethernet AUTODIN II > * CRC32/CRC32C > * @crc: seed value for computation. ~0 for Ethernet, sometimes 0 for other > * uses, or the previous crc32/crc32c value if computing incrementally. > * @p: pointer to buffer over which CRC32/CRC32C is run > * @len: length of buffer @p > * @tab: little-endian Ethernet table > * @polynomial: CRC32/CRC32c LE polynomial > */ > static inline u32 __pure crc32_le_generic(u32 crc, unsigned char const *p, > size_t len, const u32 (*tab)[256], > u32 polynomial) > { > > ... snip ... > > so what is it about that declaration that causes kerneldoc to choke? > and because those two routines are the only kerneldoc content in that > source file, the kernel-api page generated for that file is just a > dummy page, reporting an error. > > thoughts? Maybe the attached simple patch is good enough? Completely untested except for a single run against that file.... Bj?rn -------------- next part -------------- A non-text attachment was scrubbed... Name: 0001-kernel-doc-support-pointer-to-array-params.patch Type: text/x-diff Size: 1010 bytes Desc: not available Url : http://lists.kernelnewbies.org/pipermail/kernelnewbies/attachments/20150203/36e77b6f/attachment-0001.bin