Re: kernel-doc: what is the purpose of "&struct"?
From: Randy Dunlap
Date: Sat Jan 06 2007 - 13:02:13 EST
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
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/