* Question on kernel-docs comment syntax.
@ 2012-03-19 18:04 Ben Greear
2012-03-19 19:52 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Ben Greear @ 2012-03-19 18:04 UTC (permalink / raw)
To: Linux Kernel Mailing List
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
--
Ben Greear <greearb@candelatech.com>
Candela Technologies Inc http://www.candelatech.com
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: Question on kernel-docs comment syntax.
2012-03-19 18:04 Question on kernel-docs comment syntax Ben Greear
@ 2012-03-19 19:52 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2012-03-19 19:52 UTC (permalink / raw)
To: Ben Greear; +Cc: Linux Kernel Mailing List
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2012-03-19 19:52 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-03-19 18:04 Question on kernel-docs comment syntax Ben Greear
2012-03-19 19:52 ` Randy Dunlap
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).