From: Randy Dunlap <rdunlap@xenotime.net>
To: Ben Greear <greearb@candelatech.com>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: Question on kernel-docs comment syntax.
Date: Mon, 19 Mar 2012 12:52:01 -0700 [thread overview]
Message-ID: <4F678E61.9000606@xenotime.net> (raw)
In-Reply-To: <4F677546.4070500@candelatech.com>
On 03/19/2012 11:04 AM, Ben Greear wrote:
> I'd like to add some kdocs comment such that it creates a link
> to another struct (in another file/subsystem).
>
> * @get_et_stats: Ethtool API to get a set of u64 stats.
> * See @ethtool_ops
>
> The above does NOT appear to work as I would hope.
>
> I've had no luck finding documentation for the syntax....
> anyone have a pointer to a proper web page or document?
>
> Thanks,
> Ben
The only documentation for kernel-doc syntax that I know of
is in Documentation/kernel-doc-nano-HOWTO.txt .
'@' is used as a prefix for function parameters.
'&' is used as a prefix for structs.
Copying that file's text:
'funcname()' - function
'$ENVVAR' - environment variable
'&struct_name' - name of a structure (up to two words including 'struct')
'@parameter' - name of a parameter
'%CONST' - name of a constant.
HTH.
--
~Randy
prev parent reply other threads:[~2012-03-19 19:52 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-19 18:04 Question on kernel-docs comment syntax Ben Greear
2012-03-19 19:52 ` Randy Dunlap [this message]
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=4F678E61.9000606@xenotime.net \
--to=rdunlap@xenotime.net \
--cc=greearb@candelatech.com \
--cc=linux-kernel@vger.kernel.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