| Re: makedoc syntax (was Re: [AD] Screen destruction documentation update) |
[ Thread Index |
Date Index
| More lists.liballeg.org/allegro-developers Archives
]
- To: alleg-developers@xxxxxxxxxx
- Subject: Re: makedoc syntax (was Re: [AD] Screen destruction documentation update)
- From: Thomas Fjellstrom <tfjellstrom@xxxxxxxxxx>
- Date: Sat, 10 Sep 2005 15:11:09 -0600
- Domainkey-signature: a=rsa-sha1; q=dns; c=nofws; s=beta; d=gmail.com; h=received:from:to:subject:date:user-agent:references:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:message-id; b=NADXwyEUTH44qV1aFfYayrlWPqMstANrx+Bnxvr4nEJ4WcDhiP9dVBLRtk7kGu82FLWA60mQgOtiUxy90OIdex0qW8NCYDsHW9klAC40mZoHGKEvtxHzKDjApQF8rK7IHI1tg3siLtyoTFIm87TfTLndzBfHroghAuM4MEc8foU=
On September 10, 2005 01:22 pm, Peter Hull wrote:
> If it were me, I would use Doxygen to document the code, then figure
> out some way to present the web pages with a read-only
> Doxygen-generated part at the top, and a wiki-like comments section
> below (like the PHP docs, but a wiki).
>
> That way, the docs keep in sync with the code, and someone could review
> the wiki portions and copy any particular important points into the
> main Doxygen stuff.
Except Doxygen creates some of the worst docs I've ever seen.
> Pete
>
--
Thomas Fjellstrom