Date: Wed, 17 Apr 2002 10:46:22 -0400 From: Antoine Beaupre <anarcat@anarcat.ath.cx> To: Nathan Ahlstrom <nrahlstr@winternet.com> Cc: Miguel Mendez <flynn@energyhq.homeip.net>, freebsd-libh@FreeBSD.ORG Subject: Re: libh project Message-ID: <E2990B50-5211-11D6-AFCF-0050E4A0BB3F@anarcat.ath.cx> In-Reply-To: <20020417144109.GB27157@winternet.com>
index | next in thread | previous in thread | raw e-mail
Le Mercredi 17 avril 2002, à 10:41 , Nathan Ahlstrom a écrit : > >> I've been playing with libh for a while, and reading the source code. I >> think I might help documenting it. So my question is, is there a >> prefered format for that task? > > I think that Javadoc style comments are the required format, someone > correct me if I am wrong. > > The plan is to use doxygen (http://www.doxygen.org) to auto-generate > HTML from the code documentation. that's exactly it. At least, for the libh API. For other parts aspects of the system (howtos, etc), plain text is used, right now, but HTML/SGML is also recommended. A To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-libh" in the body of the messagehome | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?E2990B50-5211-11D6-AFCF-0050E4A0BB3F>