[Webkit-unassigned] [Bug 17045] [GTK] Documentation

bugzilla-daemon at webkit.org bugzilla-daemon at webkit.org
Mon Dec 8 07:09:57 PST 2008


------- Comment #18 from elle.uca at libero.it  2008-12-08 07:09 PDT -------
(In reply to comment #15)

> index f48f98f..c37d3ef 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -670,6 +670,8 @@ if test "$enable_video" = "yes"; then
>      html_flags=yes
>  fi
> +GTK_DOC_CHECK([1.10])
> +

gtk-doc help suggest to add AC_CONFIG_MACRO_DIR(m4) too (see

> diff --git a/WebKit/gtk/docs/GNUmakefile.am b/WebKit/gtk/docs/GNUmakefile.am
> new file mode 100644

I think you could remove general comment about macro usage, keeping only
relevant info. Could also be useful add
As suggested

About documentation itself, could be useful add an Overview section like:

 <chapter id="overview">
    <title>WebKit/Gtk Overview</title>
      WebKit/Gtk is the <ulink role="online-location"
      port for <ulink role="online-location"
      the open source web browser engine. A port of WebKit is a unique 
      combination of platform technologies that run the WebKit engine.
      WebKit/Gtk port uses the graphic tecnologies provided by GTK+ toolkit.

this overview chapter could be extended with sub-sections related to building
(dependencies, configure options..), compiling (against webkit, i.e. what
pkg-config stuff you have to use in order to use webkitgtk in your project) and
other stuff like the glib and gtk api refs overview (see [1] and [2])

Stupid final note: don't forget to add version control "ignore" property to
files generated by gtk-doc, for example gtk-doc.make and all .html files.

[1] http://library.gnome.org/devel/glib/stable/glib.html
[2] http://library.gnome.org/devel/gtk/stable/gtk.html

Configure bugmail: https://bugs.webkit.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.

More information about the webkit-unassigned mailing list