Re: [AD] Auto types (was: Improvements for the chm documentationversion)

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


On Sat, 2002-08-17 at 01:46, Grzegorz Adam Hankiewicz wrote:
> On Sat, Jun 01, 2002 at 03:37:46PM +0200, Elias Pschernig wrote:
> > Something which also should be added to the TOC is types, like 'man
> > BITMAP' and it would show the public members, in this case ->w and
> > ->h. For BITMAP, it would be a matter of putting @@ before it in the
> > 'Bitmap objects' section, but it would be really useful, and also @xref
> > BITMAP could be added to all bitmap functions (right now ->w and ->h
> > almost would need a FAQ entry..).
> 
> This patch may fullfill your wishes:

It does :) I only shortly looked at the HTML docs so far, and it's just
what I had in mind.

> - adds documentation about Allegro's structures and types in a separated
> chapter. This makes "man BITMAP" possible.
> 
> - fixes a bug in the texinfo generation of nodes: comparisons were being
> done ignoring case, and having one node COLOR_MAP and another color_map
> generated conflicts in the resulting .texi file.
> 
> - now chapters can be x-referenced like any other node.
> 
> - to avoid having to manually add references to BITMAP, PALETTE, etc,
> both info and html output generate them automatically detecting those
> types in the definitions.
>
> - html version is cooler, and such autotypes aren't added to the "See
> also" part, but are directly hyperlinked.

I like this a lot.

> - documentation of new section is slightly poor. Not sure if this is a
> "feature" though.
> 

I think this patch makes the Allegro docs a lot more complete, really
good work!

--
Elias Pschernig




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