public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Ben Greear <greearb@candelatech.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Question on kernel-docs comment syntax.
Date: Mon, 19 Mar 2012 11:04:54 -0700	[thread overview]
Message-ID: <4F677546.4070500@candelatech.com> (raw)

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


             reply	other threads:[~2012-03-19 18:04 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-03-19 18:04 Ben Greear [this message]
2012-03-19 19:52 ` Question on kernel-docs comment syntax Randy Dunlap

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=4F677546.4070500@candelatech.com \
    --to=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