From: Jan Engelhardt <jengelh@linux01.gwdg.de>
To: Randy Dunlap <randy.dunlap@oracle.com>
Cc: "Robert P. J. Day" <rpjday@mindspring.com>,
Linux kernel mailing list <linux-kernel@vger.kernel.org>
Subject: Re: kernel-doc: what is the purpose of "&struct"?
Date: Sat, 6 Jan 2007 21:03:54 +0100 (MET) [thread overview]
Message-ID: <Pine.LNX.4.61.0701062102080.27682@yvahk01.tjqt.qr> (raw)
In-Reply-To: <20070106100019.98da5537.randy.dunlap@oracle.com>
On Jan 6 2007 10:00, Randy Dunlap wrote:
>On Sat, 6 Jan 2007 09:44:39 -0500 (EST) Robert P. J. Day wrote:
>
>> according to the kernel-doc HOWTO, the following should be
>> "highlighted" in some way if found in the extractable documentation of
>> your source file:
>>
>> '&struct_name' - name of a structure (up to two words including 'struct')
>>
>> but examples of that, at least in the HTML, are simply printed in
>> regular font prefixed with '&' -- i don't see that any "highlighting"
>> is being done.
>
>The struct name is highlighted in 'man' output mode.
>Not done in text or html output modes.
&something is quite ambiguous when it comes near C code. So far,
I have only used e.g. %NULL (%CONSTANT) since % is not an unary
operator in C. On the other side, no marking up of any "struct".
-`J'
--
prev parent reply other threads:[~2007-01-06 20:05 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-01-06 14:44 kernel-doc: what is the purpose of "&struct"? Robert P. J. Day
2007-01-06 18:00 ` Randy Dunlap
2007-01-06 20:03 ` Jan Engelhardt [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=Pine.LNX.4.61.0701062102080.27682@yvahk01.tjqt.qr \
--to=jengelh@linux01.gwdg.de \
--cc=linux-kernel@vger.kernel.org \
--cc=randy.dunlap@oracle.com \
--cc=rpjday@mindspring.com \
/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;
as well as URLs for NNTP newsgroup(s).