From: rpjday@crashcourse.ca (Robert P. J. Day)
To: kernelnewbies@lists.kernelnewbies.org
Subject: why is "const u32 (*tab)[256]" not kerneldoc-able?
Date: Tue, 3 Feb 2015 07:19:22 -0500 (EST) [thread overview]
Message-ID: <alpine.LFD.2.11.1502030710500.18975@localhost> (raw)
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?
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
next reply other threads:[~2015-02-03 12:19 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-02-03 12:19 Robert P. J. Day [this message]
2015-02-03 13:15 ` why is "const u32 (*tab)[256]" not kerneldoc-able? Malte Vesper
2015-02-03 14:09 ` Robert P. J. Day
2015-02-03 13:18 ` Bjørn Mork
2015-02-03 13:36 ` Robert P. J. Day
2015-02-03 13:38 ` Bjørn Mork
2015-02-03 13:44 ` Robert P. J. Day
2015-02-03 14:46 ` Bjørn Mork
2015-02-03 14:50 ` Robert P. J. Day
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=alpine.LFD.2.11.1502030710500.18975@localhost \
--to=rpjday@crashcourse.ca \
--cc=kernelnewbies@lists.kernelnewbies.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).