* kernel-doc: what is the purpose of "&struct"?
@ 2007-01-06 14:44 Robert P. J. Day
2007-01-06 18:00 ` Randy Dunlap
0 siblings, 1 reply; 3+ messages in thread
From: Robert P. J. Day @ 2007-01-06 14:44 UTC (permalink / raw)
To: Linux kernel mailing list
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 intermediate XML contains simply "&struct", which certainly
doesn't suggest any special processing or highlighting.
am i missing something?
rday
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: kernel-doc: what is the purpose of "&struct"?
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
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2007-01-06 18:00 UTC (permalink / raw)
To: Robert P. J. Day; +Cc: Linux kernel mailing list
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.
> the intermediate XML contains simply "&struct", which certainly
> doesn't suggest any special processing or highlighting.
>
> am i missing something?
---
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: kernel-doc: what is the purpose of "&struct"?
2007-01-06 18:00 ` Randy Dunlap
@ 2007-01-06 20:03 ` Jan Engelhardt
0 siblings, 0 replies; 3+ messages in thread
From: Jan Engelhardt @ 2007-01-06 20:03 UTC (permalink / raw)
To: Randy Dunlap; +Cc: Robert P. J. Day, Linux kernel mailing list
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'
--
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2007-01-06 20:05 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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 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).