| Re: [AD] naturaldocs for 4.3 |
[ Thread Index |
Date Index
| More lists.liballeg.org/allegro-developers Archives
]
- To: Coordination of admins/developers of the game programming library Allegro <alleg-developers@xxxxxxxxxx>
- Subject: Re: [AD] naturaldocs for 4.3
- From: Elias Pschernig <elias@xxxxxxxxxx>
- Date: Tue, 19 Dec 2006 17:53:17 +0100
On Mon, 2006-12-18 at 11:02 +1100, Peter Wang wrote:
> Hi, the following patch adds some tags for inline documentation using
> NaturalDocs (http://naturaldocs.org/). You have can a look at what the
> output looks like at:
>
> http://home.exetel.com.au/tjaden/a5/naturaldocs/html/
>
> Not great, but better than no documentation, and easier than writing
> makedoc docs. I thought it might serve as an *interim* solution for
> documenting the 4.3 API. Anyone mind if I commit the patch?
>
Yes, looks very nice. And now with the API possibly changing a lot,
inline documentation indeed is preferable. (I'm also for switching back
to something makedoc-like in the future though.)
Oh, and can it also be made to (separately) document internals?
--
Elias Pschernig