From: bjorn@mork.no (Bjørn Mork)
To: kernelnewbies@lists.kernelnewbies.org
Subject: why is "const u32 (*tab)[256]" not kerneldoc-able?
Date: Tue, 03 Feb 2015 15:46:13 +0100 [thread overview]
Message-ID: <874mr3uk7e.fsf@nemi.mork.no> (raw)
In-Reply-To: <alpine.LFD.2.11.1502030839290.6427@localhost> (Robert P. J. Day's message of "Tue, 3 Feb 2015 08:44:50 -0500 (EST)")
"Robert P. J. Day" <rpjday@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
next prev parent reply other threads:[~2015-02-03 14:46 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-02-03 12:19 why is "const u32 (*tab)[256]" not kerneldoc-able? Robert P. J. Day
2015-02-03 13:15 ` 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 [this message]
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=874mr3uk7e.fsf@nemi.mork.no \
--to=bjorn@mork.no \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.