Re: [PATCH] documentation

[Malcolm Tredinnick <malcolm commsecure com au>]

More comments ...

On Thu, Dec 12, 2002 at 12:01:45PM +0100, Diego González wrote:
> this is a new documentation patch, with the suggestions from Malcolm
> incorporated:
> 
> Switch to use libxslt to generate the help 
> Check for gtk-doc >= 0.10
> Inline the documentation in header files
> Marked some of the functions added in the 2.2 dev cicle with 
> "Since: 2.2", so that it shows in the documentation
> Added help for some enums and functions.
> 
> I have regenerated the help in my computer and it seems to work. 

You have added --sgml-mode to MKDB_OPTIONS (in doc/Makefile.am) and that
was not there previously. You now have to go through every single
documentation comment and check that all "special" characters are marked
up as the appropriate entities (e.g. '>' in a comment must now be >,
etc). It would really be better to not introduce this option unless you
are have checked every single comment.

Does 'make distcheck' really pass? It seems like you have not changed
the dist-hook rule in doc/Makefile.am, so it will still look in
doc/sgml, rather than doc/xml in some casesi (look at line 199 in the
current CVS doc/Makefile.am). I may be wrong about this one (don't have
a gnome-vfs build around to check it with at the work at the moment),
but that has needed to be changed everywhere else, so I don't see why
gnome-vfs would be different.

Malcolm

-- 
"Very funny, Scotty. Now beam down my clothes."