[Spice-devel] Gtk-doc VS Doxygen

[Pavel Grunt]

Hi,

On Fri, 2016-05-20 at 06:44 -0400, Frediano Ziglio wrote:
> Hi,
>   I'd like to have some standard on the internal documentation of spice-
> server.
> 
Yes, that would be nice.

> The current situation is quite messy having different styles.
> I think the worst think is not having any documentation, so better messy
> than nothing.
> I really like Doxygen as it's really complete tool however my Gtk-doc
> knowledge
> is very low and I cannot compare the two.

"GTK-Doc has some special code to document the signals and properties of GTK+
widgets and GObject classes which other tools may not have." [0]

But I think the same can be achieved with Doxygen.

> I know we use quite a lot of "G" stuff so perhaps people feels more
> comfortable
> with Gtk-doc.
> I'd like to see the documentation generated and possibly published on web
> so suggestion from the guys who maintain the website are really welcome.

Both Doxygen and gtk-doc can be used. We are using gtk-doc for spice-gtk, it is
not planned to switch to something else.

[0] http://www.gtk.org/gtk-doc/

Pavel
> 
> Frediano
> _______________________________________________
> Spice-devel mailing list
> Spice-devel at lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/spice-devel