Date: Sat, 6 Jan 2007 21:03:54 +0100 (MET)
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"?
In-Reply-To: <20070106100019.98da5537.randy.dunlap@oracle.com>
Message-ID: <Pine.LNX.4.61.0701062102080.27682@yvahk01.tjqt.qr>
References: <Pine.LNX.4.64.0701060941240.13398@localhost.localdomain>
 <20070106100019.98da5537.randy.dunlap@oracle.com>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 1062
Lines: 28


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'
-- 
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/