Re: [AD] Documentation system 2009

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


On January 10, 2009, Elias Pschernig wrote:
> On Sat, 2009-01-10 at 20:03 +1100, Peter Wang wrote:
> > I think this alternative is easier to work with than separate files.
> > The above description implies separate tags "Function:", "Type:",
> > "Enum:" as in Natural Docs, but since it only served to complicate the
> > scripts, I've unified them under "API:".
> >
> > Patch attached.  The scripts are written in shell (they'd be trivial to
> > rewrite, even in C).  Natural Docs have been extracted but not
> > reformatted. The CMake build will generate HTML, man and info documents
> > (if enabled).
> >
> > I'll get some more opinions before committing.
>
> I like the idea, it's similar to how the pygame documentation works.
>
> Should I translate the shell scripts to Python btw? It would mean they
> run also in Windows, and they would be much easier to read. And we would
> not need helper programs like faster_search.

If you don't mind being the sole maintainer of said scripts. Unless of course 
others here do python.

> --
> Elias Pschernig <elias@xxxxxxxxxx>
>
>
> ---------------------------------------------------------------------------
>--- Check out the new SourceForge.net Marketplace.
> It is the best place to buy or sell services for
> just about anything Open Source.
> http://p.sf.net/sfu/Xq1LFB


-- 
Thomas Fjellstrom
tfjellstrom@xxxxxxxxxx




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