From owner-freebsd-libh Wed Apr 17 7:48:16 2002 Delivered-To: freebsd-libh@freebsd.org Received: from mail1.qc.uunet.ca (mail1.qc.uunet.ca [198.168.54.16]) by hub.freebsd.org (Postfix) with ESMTP id 6338A37B41A for ; Wed, 17 Apr 2002 07:48:12 -0700 (PDT) Received: from Xtanbul ([216.94.147.34]) by mail1.qc.uunet.ca (8.10.2/8.10.2) with ESMTP id g3HEluj17052; Wed, 17 Apr 2002 10:47:56 -0400 Date: Wed, 17 Apr 2002 10:46:22 -0400 Subject: Re: libh project Content-Type: text/plain; charset=ISO-8859-1; format=flowed Mime-Version: 1.0 (Apple Message framework v481) Cc: Miguel Mendez , freebsd-libh@FreeBSD.ORG To: Nathan Ahlstrom From: Antoine Beaupre In-Reply-To: <20020417144109.GB27157@winternet.com> Message-Id: Content-Transfer-Encoding: quoted-printable X-Mailer: Apple Mail (2.481) Sender: owner-freebsd-libh@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.ORG Le Mercredi 17 avril 2002, =E0 10:41 , Nathan Ahlstrom a =E9crit : > >> 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=20= of the system (howtos, etc), plain text is used, right now, but=20 HTML/SGML is also recommended. A To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-libh" in the body of the message