Date: Mon, 01 Nov 1999 20:31:59 -0800 From: Sean Kelly <kelly@ad1440.net> To: Nik Clayton <nik@freebsd.org> Cc: freebsd-doc@freebsd.org Subject: Re: Markup for preprocessor symbols Message-ID: <381E693F.3EBE8054@ad1440.net> References: <380CB16B.5340C70E@ad1440.net> <19991025081540.D2102@kilt.nothing-going-on.org>
next in thread | previous in thread | raw e-mail | index | archive | help
> The Davenport folks
> can probably give you a better idea of what to use -- when you find out,
> can you post back here, and I'll add it to the primer.
Well, despite its mathematic leanings, Norman Walsh prefers to markup
preprocessor symbols with <symbol>. Another user on the list suggested
that preprocessor symbols be marked up with their intended use:
<constant> or <function>.
I'm thinking:
#define HEADER_H use <symbol>HEADER_H</symbol>
#define PI 3.14159 use <constant>PI</constant>
#define F(X) f(x) use <function>F</function>
But, that might be splitting hairs a bit to finely for some tastes.
Take care.
--Sean
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?381E693F.3EBE8054>