linux-kernel - Re: kernel-doc: what is the purpose of "&struct"?

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] [thread-next>] [day] [month] [year] [list]

Message-Id: <20070106100019.98da5537.randy.dunlap@oracle.com>
Date:	Sat, 6 Jan 2007 10:00:19 -0800
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	"Robert P. J. Day" <rpjday@...dspring.com>
Cc:	Linux kernel mailing list <linux-kernel@...r.kernel.org>
Subject: Re: kernel-doc:  what is the purpose of "&struct"?

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 "&amp;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@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/