[Denemo-devel] Denemo reference with gtkdoc

[Éloi Rivard]

Hi,

I have created a gtkdoc branch that creates a html reference of the source code, in the GNOME fashion (See for example https://developer.gnome.org/gtk3/stable/GtkDialog.html).

On .deb systems you will need to install the package "gtk-doc-tools", and then run

./autogen.sh

Reference generation is disabled by default but you can enable it with :

./configure --enable-gtk-doc

Then you can read the reference at docs/reference/denemo/html/index.html

It does not have a lot of information now because the code is mostly uncommented. But this can motive us to comment a bit more. The syntax of the comments used by gtk-doc is very similar to doxygen syntax, and can be read here : https://wiki.gnome.org/DocumentationProject/GtkDoc#Documenting_a_section

The main drawback is that now autogen.sh has a further dependency, that is gtkdoc.

Could you please test and give your thoughts about this ?

--
Éloi Rivard - address@hidden
       
« On perd plus à être indécis qu'à se tromper. »