From owner-freebsd-libh  Tue Apr  9 19:35:44 2002
Delivered-To: freebsd-libh@freebsd.org
Received: from tomts5-srv.bellnexxia.net (tomts5.bellnexxia.net [209.226.175.25])
	by hub.freebsd.org (Postfix) with ESMTP id CF5D737B421
	for <libh@FreeBSD.org>; Tue,  9 Apr 2002 19:35:34 -0700 (PDT)
Received: from khan.anarcat.dyndns.org ([65.94.186.97])
          by tomts5-srv.bellnexxia.net
          (InterMail vM.4.01.03.23 201-229-121-123-20010418) with ESMTP
          id <20020410023532.TTAN10852.tomts5-srv.bellnexxia.net@khan.anarcat.dyndns.org>
          for <libh@FreeBSD.org>; Tue, 9 Apr 2002 22:35:32 -0400
Received: from lenny.anarcat.dyndns.org (lenny.anarcat.dyndns.org [192.168.0.4])
	by khan.anarcat.dyndns.org (Postfix) with SMTP id 42722191F
	for <libh@FreeBSD.org>; Tue,  9 Apr 2002 22:35:27 -0400 (EDT)
Received: by lenny.anarcat.dyndns.org (sSMTP sendmail emulation); Tue, 9 Apr 2002 22:34:22 -0400
Date: Tue, 9 Apr 2002 22:34:22 -0400
From: The Anarcat <anarcat@anarcat.dyndns.org>
To: libh@FreeBSD.org
Subject: Re: cvs commit: libh/include Pointer.hh
Message-ID: <20020410023422.GA37565@lenny.anarcat.dyndns.org>
References: <200204100231.g3A2VAP05050@usw4.freebsd.org>
Mime-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha1;
	protocol="application/pgp-signature"; boundary="XsQoSWH+UP9D9v3l"
Content-Disposition: inline
In-Reply-To: <200204100231.g3A2VAP05050@usw4.freebsd.org>
User-Agent: Mutt/1.3.27i
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


--XsQoSWH+UP9D9v3l
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

More commits to come.

This will be done in phases, again:

1- converting comments
2- rephrasing comments (moving comments clearly related to code
structure out of class descriptions and create class descriptions
where missing)
3- all-new comments (description of undocumented classes)

I think [1] and [2] will be finished pretty quickly.

[3] is an ever-going job.

A.

On Tue Apr 09, 2002 at 09:31:10PM -0500, Antoine Beaupr=E9 wrote:
> antoine     2002/04/09 21:31:10 CDT
>=20
>   Modified files:
>     include              Pointer.hh=20
>   Log:
>   convert comments to javadoc-style
>  =20
>   this commit shows how to convert existing class documentation to fit
>   in the new documentation system,
>  =20
>   in general, long comments should be surrounded with:
>  =20
>   /**
>    * ...
>    */
>  =20
>   and short comments (oneliners) should be formatted as
>  =20
>   /// ...
>  =20
>   Revision  Changes    Path
>   1.7       +8 -8      libh/include/Pointer.hh
>=20
>=20
> To Unsubscribe: send mail to majordomo@FreeBSD.org
> with "unsubscribe freebsd-libh" in the body of the message

--XsQoSWH+UP9D9v3l
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (FreeBSD)
Comment: For info see http://www.gnupg.org

iEYEARECAAYFAjyzpK4ACgkQttcWHAnWiGf6CgCfa4tiuRt++7VjmBzDSFPid5qG
+q8An3EZ230khWkUV1AbeKQ7G4UXqauq
=Wley
-----END PGP SIGNATURE-----

--XsQoSWH+UP9D9v3l--

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