Re: [AD] Proposed changes for Allegro 5 (6?)

[ Thread Index | Date Index | More lists.liballeg.org/allegro-developers Archives ]


Stepan Roh wrote:
> But in-source documentation is good thing.

There are some problems with it too:
 - Is it possible to make sections be structured another way than the
source files? It would be confusing if there was one section for the
functions in gfx.c and another for the functions in graphics.c, or if
load_bmp(), load_pcx() etc were in different sections.
 - Some functions are defined in different files depending on which
platform they are on, so there's no unique natural place to put the
documentation on.
 - allegro._tx contains several generic sections that discuss
programming principles (e.g. "Bitmap objects"), or non-api stuff (e.g.
"Makefile targets"), that would not fit in naturally in any source file.
 - allegro._tx is not the only file generated by makedoc: there are
totally 8 files mathching allegro/docs/src/*._tx. So we need something
to compile help that does not come from a source file anyway.

-- 
Sven Sandberg    svsa1977@xxxxxxxxxx    home.student.uu.se/svsa1977



Mail converted by MHonArc 2.6.19+ http://listengine.tuxfamily.org/