linux-kernel - Re: Question on kernel-docs comment syntax.

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:	Mon, 19 Mar 2012 12:52:01 -0700
From:	Randy Dunlap <rdunlap@...otime.net>
To:	Ben Greear <greearb@...delatech.com>
CC:	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>
Subject: Re: Question on kernel-docs comment syntax.

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')
'@...ameter' - name of a parameter
'%CONST' - name of a constant.

HTH.
-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/