2009-03-30 Gustavo Noronha Silva <gustavo.noronha@collabora.co.uk>
authorkov@webkit.org <kov@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 31 Mar 2009 02:41:46 +0000 (02:41 +0000)
committerkov@webkit.org <kov@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 31 Mar 2009 02:41:46 +0000 (02:41 +0000)
        Reviewed by Holger Freyther.

        Integrate gtk-doc into the Gtk+ buildsystem.

        Based on original work by Holger Freyther.

        Integrate gtk-doc into our buildsystem. We are forced to
        use recursive make for gtk-doc itself as the to be installed
        gtk-doc.make (done by gtkdocize) is not working in a non
        recursive environment.

        The documentation can only be generated when srcdir == builddir.
        In all other cases the generated files will not be found. This
        limitation can be found in pango and gtk+ as well. There is no
        easy way around. The resulting html documentation will be saved
        in the srcdir as well.

        * docs/GNUmakefile.am: Added.
        * docs/version.xml.in: Added.
        * docs/webkitgtk-docs.sgml:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@42123 268f45cc-cd09-0410-ab3c-d52691b4dbfc

ChangeLog
WebKit/gtk/ChangeLog
WebKit/gtk/docs/GNUmakefile.am [new file with mode: 0644]
WebKit/gtk/docs/version.xml.in [new file with mode: 0644]
WebKit/gtk/docs/webkitgtk-docs.sgml
autogen.sh
configure.ac

index 065a8bc..1ce22a3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2009-03-30  Gustavo Noronha Silva <gustavo.noronha@collabora.co.uk>
+
+        Reviewed by Holger Freyther.
+
+        Integrate gtk-doc into the Gtk+ buildsystem.
+
+        * autogen.sh:
+        * configure.ac:
+
 2009-03-30  Xan Lopez  <xlopez@igalia.com>
 
         Unreviewed: bump version to 1.1.4 for release.
index 363c1db..2a26551 100644 (file)
@@ -1,3 +1,26 @@
+2009-03-30  Gustavo Noronha Silva <gustavo.noronha@collabora.co.uk>
+
+        Reviewed by Holger Freyther.
+
+        Integrate gtk-doc into the Gtk+ buildsystem.
+
+        Based on original work by Holger Freyther.
+
+        Integrate gtk-doc into our buildsystem. We are forced to
+        use recursive make for gtk-doc itself as the to be installed
+        gtk-doc.make (done by gtkdocize) is not working in a non
+        recursive environment.
+
+        The documentation can only be generated when srcdir == builddir.
+        In all other cases the generated files will not be found. This
+        limitation can be found in pango and gtk+ as well. There is no
+        easy way around. The resulting html documentation will be saved
+        in the srcdir as well.
+
+        * docs/GNUmakefile.am: Added.
+        * docs/version.xml.in: Added.
+        * docs/webkitgtk-docs.sgml:
+
 2009-03-30  Gustavo Noronha Silva  <gustavo.noronha@collabora.co.uk>
 
         Unreviewed. Documenting what changed since the 1.1.3 release, in
diff --git a/WebKit/gtk/docs/GNUmakefile.am b/WebKit/gtk/docs/GNUmakefile.am
new file mode 100644 (file)
index 0000000..d3ef7ff
--- /dev/null
@@ -0,0 +1,104 @@
+## Process this file with automake to produce GNUmakefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=webkitgtk
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../webkit
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=--deprecated-guards="WEBKIT_DISABLE_DEPRECATED" --ignore-decorators="WEBKIT_API"
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml --source-suffixes=h,c,cpp
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/WebKit/gtk/webkit/*.h
+CFILE_GLOB=$(top_srcdir)/WebKit/gtk/webkit/*.cpp
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=webkitprivate.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES= \
+       -I$(top_srcdir)/WebKit/gtk \
+       -I$(top_builddir)/WebKit/gtk \
+       $(global_cppflags) \
+       $(global_cflags) \
+       -I$(top_srcdir) \
+       -I$(top_srcdir)/JavaScriptCore \
+       -I$(top_srcdir)/JavaScriptCore/ForwardingHeaders \
+       -I$(top_srcdir)/JavaScriptCore/parser \
+       -I$(top_srcdir)/JavaScriptCore/wtf \
+       -I$(top_builddir)/DerivedSources \
+       $(GLOBALDEPS_CFLAGS) \
+       $(CAIRO_CFLAGS) \
+       $(GTK_CFLAGS) \
+       $(LIBSOUP_CFLAGS)
+GTKDOC_LIBS= \
+       $(top_builddir)/libwebkit-1.0.la \
+       $(GTK_LIBS) \
+       $(LIBSOUP_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+#TESTS = $(GTKDOC_CHECK)
+
diff --git a/WebKit/gtk/docs/version.xml.in b/WebKit/gtk/docs/version.xml.in
new file mode 100644 (file)
index 0000000..d78bda9
--- /dev/null
@@ -0,0 +1 @@
+@VERSION@
index 655a991..25000b4 100644 (file)
@@ -1,14 +1,12 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
+]>
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
-    <title>webkitgtk Reference Manual</title>
-    <releaseinfo>
-      for webkitgtk [VERSION]
-      The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://[SERVER]/webkitgtk/index.html">http://[SERVER]/webkitgtk/</ulink>.
-    </releaseinfo>
+    <title>WebKit/Gtk+ Reference Manual</title>
+    <releaseinfo>for WebKit/Gtk+ &version;</releaseinfo>
   </bookinfo>
 
   <chapter>
index f87238c..8f736c4 100755 (executable)
@@ -14,6 +14,14 @@ AUTOMAKE_FLAGS="--foreign --add-missing"
 
 DIE=0
 
+(gtkdocize --version) < /dev/null > /dev/null 2>&1 || {
+    echo
+    echo "You must have gtkdocize installed to compile $PROJECT."
+    echo "Install the appropriate package for your distribution,"
+    echo "or get the source tarball at http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/"
+    DIE=1
+}
+
 (autoconf --version) < /dev/null > /dev/null 2>&1 || {
     echo
     echo "You must have autoconf installed to compile $PROJECT."
@@ -50,6 +58,7 @@ rm -rf $top_srcdir/autom4te.cache
 
 touch README INSTALL
 
+gtkdocize || exit $?
 aclocal $ACLOCAL_FLAGS || exit $?
 $LIBTOOLIZE $LIBTOOLIZE_FLAGS || exit $?
 autoheader || exit $?
index 7409d26..37349f3 100644 (file)
@@ -598,6 +598,8 @@ if test "$enable_video" = "yes"; then
     html_flags=yes
 fi
 
+GTK_DOC_CHECK([1.10])
+
 # OS conditionals
 AM_CONDITIONAL([OS_WIN32],[test "$os_win32" = "yes"])
 AM_CONDITIONAL([OS_UNIX],[test "$os_win32" = "no"])
@@ -649,6 +651,8 @@ AC_CONFIG_FILES([
 GNUmakefile
 WebKit/gtk/webkit-1.0.pc:WebKit/gtk/webkit.pc.in
 WebKit/gtk/webkit/webkitversion.h
+WebKit/gtk/docs/GNUmakefile
+WebKit/gtk/docs/version.xml
 ]
 )