From owner-freebsd-libh  Mon Oct 14 20:22: 9 2002
Delivered-To: freebsd-libh@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 5D3EE37B401
	for <freebsd-libh@freebsd.org>; Mon, 14 Oct 2002 20:22:07 -0700 (PDT)
Received: from aeimail.aei.ca (aeimail.aei.ca [206.123.6.14])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 9659243EAC
	for <freebsd-libh@freebsd.org>; Mon, 14 Oct 2002 20:22:06 -0700 (PDT)
	(envelope-from anarcat@anarcat.ath.cx)
Received: from shall.anarcat.ath.cx (ccnf2uflnqqyt861@dsl-130-178.aei.ca [66.36.130.178])
	by aeimail.aei.ca (8.11.6/8.10.1) with ESMTP id g9F3M1r21708
	for <freebsd-libh@freebsd.org>; Mon, 14 Oct 2002 23:22:01 -0400 (EDT)
Received: from lenny.anarcat.ath.cx (lenny.anarcat.ath.cx [192.168.0.4])
	by shall.anarcat.ath.cx (Postfix) with SMTP id B5AE03DD
	for <freebsd-libh@freebsd.org>; Mon, 14 Oct 2002 23:21:50 -0400 (EDT)
Received: by lenny.anarcat.ath.cx (sSMTP sendmail emulation); Mon, 14 Oct 2002 23:21:11 -0400
Date: Mon, 14 Oct 2002 23:21:11 -0400
From: The Anarcat <anarcat@anarcat.ath.cx>
To: Libh <freebsd-libh@freebsd.org>
Subject: Style guide suggestion
Message-ID: <20021015032111.GA90347@lenny.anarcat.ath.cx>
Mail-Followup-To: The Anarcat <anarcat@anarcat.ath.cx>,
	Libh <freebsd-libh@freebsd.org>
Mime-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="cNdxnHkX5QqsyA0e"
Content-Disposition: inline
User-Agent: Mutt/1.5.1i
Sender: owner-freebsd-libh@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-libh.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-libh>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-libh>
X-Loop: FreeBSD.ORG


--cNdxnHkX5QqsyA0e
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

I suggest the following patch as a preliminary style guide for libh.

(I always seem to forget the basics of doxygen's format, so I thought
putting some examples in there to make life easier for readers and
developers alike. :)

A.

Index: HACKERS
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/libh/cvs/libh/HACKERS,v
retrieving revision 1.5
diff -u -u -r1.5 HACKERS
--- HACKERS	22 Apr 2002 18:08:03 -0000	1.5
+++ HACKERS	15 Oct 2002 03:19:43 -0000
@@ -6,6 +6,33 @@
 This is a simple guide where guidelines to develop libh should be
 stored.
=20
+Style
+--------------------------------------------------------------------------=
----
+
+Please follow style(9) when possible.
+
+Comments should be formatted in Doxygen format, that is:
+
+/**
+ * Function name
+ *
+ * description.
+ *=20
+ * Another description paragraph, multi-line
+ * this time.
+ *
+ * @param p a parameter
+ * @returns function return value
+ * @see that_other_function()
+ */
+
+or
+
+/// single line comments
+
+Class/interface descriptions must be stored in the .h[h]
+files.
+
 Current functionality
 --------------------------------------------------------------------------=
----
=20


--=20
Premature optimization is the root of all evil
                        - Donald Knuth

--cNdxnHkX5QqsyA0e
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.0 (FreeBSD)

iD8DBQE9q4mmttcWHAnWiGcRAjJUAJ0aWOO2Vc3u9ms2ln7QcM/2HhuQuACgmPnB
ib6W4GZm235pW3C60cJCkR8=
=Re5Q
-----END PGP SIGNATURE-----

--cNdxnHkX5QqsyA0e--

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-libh" in the body of the message