X-Authentication-Warning:	delorie.com: mail set sender to djgpp-workers-bounces using -f
X-Recipient:	djgpp-workers AT delorie DOT com
Date:	Sat, 24 Jan 2009 16:17:53 +0200
From:	Eli Zaretskii <eliz AT gnu DOT org>
Subject:	Re: djgpp: djgpp/src/libc/ansi/stdio/printf.txh
In-reply-to:	<002701c97e28$a36ea9a0$2202a8c0@computername>
X-012-Sender:	halo1 AT inter DOT net DOT il
To:	Juan Manuel Guerrero <juan DOT guerrero AT gmx DOT de>
Cc:	djgpp-workers AT delorie DOT com
Message-id:	<ufxj8u6su.fsf@gnu.org>
References:	<200901232346 DOT n0NNk61M003848 AT delorie DOT com> <uvds5t53c DOT fsf AT gnu DOT org> <002701c97e28$a36ea9a0$2202a8c0 AT computername>
Reply-To:	djgpp-workers AT delorie DOT com
Errors-To:	nobody AT delorie DOT com
X-Mailing-List:	djgpp-workers AT delorie DOT com
X-Unsubscribes-To:	listserv AT delorie DOT com

> From: "Juan Manuel Guerrero" <juan DOT guerrero AT gmx DOT de>
> Cc: <djgpp-workers AT delorie DOT com>
> Date: Sat, 24 Jan 2009 14:35:35 +0100
> 
> @subheading Syntax
> 
> @example
> #include <stdlib.h>
> 
> double atof(const char *string);
> @end example
> 
> As can be seen the @var markup is not used at all there and this is valid for
> all .txh files I have inspected.  IMHO the code line looks better without the
> markup effect because the C coder ussualy uses lower case characters, so the
> syntax line looks more naturaly.  Anyway, I have no preferences, but to avoid
> future inconveniences a definitive rule how to handle this issue should be
> established and then all .txh files should be changed accordingly.

The rule should be to use @var for formal parameters.  FWIW, the glibc
docs does that (they actually use @defun, but the effect is the same:
the formal parameters get the @var markup).

I am not going to ask you to modify all of the *.txh files to adhere
to this rule, but please don't change those that already use it, and
whenever you modify one of them, please take a moment to fix it while
at that.

Thanks.

- Raw text -