Re: [AD] Improvements for the chm documentation version |
[ Thread Index |
Date Index
| More lists.liballeg.org/allegro-developers Archives
]
> Hello.
>
> Here are some proposed improvements to the chm documentation:
>
> - It builds, believe it or not, the cvs didn't for me.
Yes, I had noticed recently, but had no time to check if it was a local
problem. With the patch, it works, I just have to manually create the
docs/chm dir, the makefile just tells me this:
mkdir docs/chm
Invalid Option - /CHM
> - The toc has been removed from the pages themselves, since it's already
> at the left side of the screen.
True, it's not really needed with the CHM. Would it be difficult/useful to
also include hnodes in the TOC?
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..).
The same would be useful for other structs, which aren't explained yet.
> - To do the previous, chm documentation has to be generated in another
> directory, because the html will be different.
> - The toc on the left side of the screen now is alphabetically sorted.
> - The more descriptive document_title is used for the chm title, and
> filename is used as before if not available.
> - Minor changes here and there, including makefile.
>
> Please, somebody with a windows machine test this.
--
Elias Pschernig