From owner-freebsd-doc  Mon Nov  1 20:32:43 1999
Delivered-To: freebsd-doc@freebsd.org
Received: from cbl-skelly3.hs.earthlink.net (CBL-skelly3.hs.earthlink.net [209.178.114.61])
	by hub.freebsd.org (Postfix) with ESMTP
	id 2B61014E7A; Mon,  1 Nov 1999 20:32:22 -0800 (PST)
	(envelope-from kelly@ad1440.net)
Received: from ad1440.net (thyme.rosetta.zon [172.16.16.105])
	by cbl-skelly3.hs.earthlink.net (8.9.2/8.9.2) with ESMTP id UAA44885;
	Mon, 1 Nov 1999 20:32:20 -0800 (PST)
	(envelope-from kelly@ad1440.net)
Message-ID: <381E693F.3EBE8054@ad1440.net>
Date: Mon, 01 Nov 1999 20:31:59 -0800
From: Sean Kelly <kelly@ad1440.net>
X-Mailer: Mozilla 4.51 [en] (Win95; I)
X-Accept-Language: en
MIME-Version: 1.0
To: Nik Clayton <nik@freebsd.org>
Cc: freebsd-doc@freebsd.org
Subject: Re: Markup for preprocessor symbols
References: <380CB16B.5340C70E@ad1440.net> <19991025081540.D2102@kilt.nothing-going-on.org>
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
X-Loop: FreeBSD.org

> 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