Style guide suggestion

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
===================================================================
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.
 
+Style
+------------------------------------------------------------------------------
+
+Please follow style(9) when possible.
+
+Comments should be formatted in Doxygen format, that is:
+
+/**
+ * Function name
+ *
+ * description.
+ * 
+ * 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
 ------------------------------------------------------------------------------
 


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

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

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