Re: [xmlroff] xmlroff release is delayed

[Stefan S. <se...@sy...>]

Tony Graham wrote:

>>Speaking of which, do you have a tool to generate documentation from your
>>source code ? Synopsis has a new C parser and I'm looking for a victim... :-)
> 
> 
> gtk-doc.
> 
> Can Synopsis parse gtk-doc comments?

yes, you can teach it to parse comments as you want, by means of python
modules.

> Can Synopsis included "static" documentation and annotations to the
> generated documentation in the way that gtk-doc can?

I'm not sure what you mean in detail, but it is certainly possible
to either include links to external docs, or even mix in existing
documents into a single generated document.

Synopsis can also be used to create a cross-referenced view of the
source code itself, so you can navigate through the code by clicking
on variables and function calls, taking you to their respective
declaration/definition.

> If you can modify configure.in to enable Synopsis documentation
> generation (with no ill-effect if Synopsis is not present) just as
> --enable-gtk-doc enables gtk-doc documentation, then you can check it
> in.
> 
> Synopsis would have to be an option alongside gtk-doc, and for the
> moment at least, the xmlroff distributions would still ship with
> gtk-doc documentation.

I'll have a look. If gtk-doc is already doing a fine job for what
you want it to do there is no reason to change / add anything.

Regards,
		Stefan