Diff
Modified: trunk/ChangeLog (96610 => 96611)
--- trunk/ChangeLog 2011-10-04 18:00:32 UTC (rev 96610)
+++ trunk/ChangeLog 2011-10-04 18:02:41 UTC (rev 96611)
@@ -1,3 +1,15 @@
+2011-10-04 Nayan Kumar K <[email protected]>
+
+ [WebKit2][gtk] Generate gtk-doc for WebKit2-GTK.
+ https://bugs.webkit.org/show_bug.cgi?id=69325
+
+ Reviewed by Gustavo Noronha Silva.
+
+ Documentation generation for WebKit2-GTK+ APIs
+ using gtk-doc.
+
+ * configure.ac:
+
2011-10-04 Vsevolod Vlasov <[email protected]>
Web Inspector: Remove http/tests/inspector/network/disabled-cache-crash.html.
Modified: trunk/Source/WebKit2/ChangeLog (96610 => 96611)
--- trunk/Source/WebKit2/ChangeLog 2011-10-04 18:00:32 UTC (rev 96610)
+++ trunk/Source/WebKit2/ChangeLog 2011-10-04 18:02:41 UTC (rev 96611)
@@ -1,5 +1,22 @@
2011-10-04 Nayan Kumar K <[email protected]>
+ [WebKit2][gtk] Generate gtk-doc for WebKit2-GTK.
+ https://bugs.webkit.org/show_bug.cgi?id=69325
+
+ Reviewed by Gustavo Noronha Silva.
+
+ Documentation generation for WebKit2-GTK+ APIs
+ using gtk-doc.
+
+ * GNUmakefile.am: Added doc generation files to EXTRA_DIST.
+ * UIProcess/API/gtk/docs/GNUmakefile.am: Makefile for doc generation.
+ * UIProcess/API/gtk/docs/version.xml.in: Version information.
+ * UIProcess/API/gtk/docs/webkit2gtk-docs.sgml: Document template.
+ * UIProcess/API/gtk/docs/webkit2gtk-sections.txt: Document sections added.
+ * UIProcess/API/gtk/docs/webkit2gtk.types: Added GObjects types.
+
+2011-10-04 Nayan Kumar K <[email protected]>
+
[WebKit2][gtk] Fix warnings while generating documentation using gtk-doc.
https://bugs.webkit.org/show_bug.cgi?id=69329
Modified: trunk/Source/WebKit2/GNUmakefile.am (96610 => 96611)
--- trunk/Source/WebKit2/GNUmakefile.am 2011-10-04 18:00:32 UTC (rev 96610)
+++ trunk/Source/WebKit2/GNUmakefile.am 2011-10-04 18:02:41 UTC (rev 96611)
@@ -1390,3 +1390,10 @@
$(global_cxxflags)
endif
+
+EXTRA_DIST += \
+ $(WebKit2)/UIProcess/API/gtk/docs/GNUmakefile.am \
+ $(WebKit2)/UIProcess/API/gtk/docs/webkitgtk-docs.sgml \
+ $(WebKit2)/UIProcess/API/gtk/docs/webkitgtk-sections.txt \
+ $(WebKit2)/UIProcess/API/gtk/docs/version.xml.in \
+ $(WebKit2)/UIProcess/API/gtk/docs/webkit2gtk.types
Added: trunk/Source/WebKit2/UIProcess/API/gtk/docs/GNUmakefile.am (0 => 96611)
--- trunk/Source/WebKit2/UIProcess/API/gtk/docs/GNUmakefile.am (rev 0)
+++ trunk/Source/WebKit2/UIProcess/API/gtk/docs/GNUmakefile.am 2011-10-04 18:02:41 UTC (rev 96611)
@@ -0,0 +1,108 @@
+## 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=webkit2gtk
+
+# 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=$(top_srcdir)/Source/WebKit2/UIProcess/API/gtk
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS="--type-init-func=g_thread_init(NULL);g_type_init()"
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=--ignore-decorators="WK_EXPORT"
+
+# 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)/Source/WebKit2/UIProcess/API/gtk/*.h
+CFILE_GLOB=$(top_srcdir)/Source/WebKit2/UIProcess/API/gtk/*.cpp
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES = \
+ WebKitWebViewBasePrivate.h \
+ PageClientImpl.h \
+ WebKitPrivate.h \
+ WebKitWebContextPrivate.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)/Source \
+ -I$(top_srcdir)/Source/WebKit2 \
+ -I$(top_builddir)/DerivedSources \
+ -I$(top_builddir)/DerivedSources/WebKit2/include \
+ -I$(top_builddir)/DerivedSources/WebKit2/webkit2gtk \
+ -I$(top_builddir)/DerivedSources/WebKit2/webkit2gtk/include \
+ -I$(top_srcdir)/Source/WebKit2/UIProcess/API/gtk \
+ $(global_cppflags) \
+ $(global_cflags) \
+ $(GLIB_CFLAGS) \
+ $(GTK_CFLAGS) \
+ $(LIBSOUP_CFLAGS) \
+ $(_javascript_core_cppflags)
+
+GTKDOC_LIBS= \
+ $(top_builddir)/libjavascriptcoregtk-@WEBKITGTK_API_MAJOR_VERSION@.@[email protected] \
+ $(top_builddir)/libwebkit2gtk-@WEBKITGTK_API_MAJOR_VERSION@.@[email protected] \
+ $(GLIB_LIBS) \
+ $(GTK_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)
Added: trunk/Source/WebKit2/UIProcess/API/gtk/docs/version.xml.in (0 => 96611)
--- trunk/Source/WebKit2/UIProcess/API/gtk/docs/version.xml.in (rev 0)
+++ trunk/Source/WebKit2/UIProcess/API/gtk/docs/version.xml.in 2011-10-04 18:02:41 UTC (rev 96611)
@@ -0,0 +1 @@
+@VERSION@
Added: trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml (0 => 96611)
--- trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml (rev 0)
+++ trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-docs.sgml 2011-10-04 18:02:41 UTC (rev 96611)
@@ -0,0 +1,24 @@
+<?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" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <bookinfo>
+ <title>WebKit2GTK+ Reference Manual</title>
+ <releaseinfo>for WebKit2GTK+ &version;</releaseinfo>
+ </bookinfo>
+
+ <chapter>
+ <title>Class Overview</title>
+ <xi:include href=""
+ <xi:include href=""
+ <xi:include href=""
+ <xi:include href=""
+ <xi:include href=""
+ </chapter>
+
+ <index id="index-all">
+ <title>Index</title>
+ </index>
+</book>
Added: trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt (0 => 96611)
--- trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt (rev 0)
+++ trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk-sections.txt 2011-10-04 18:02:41 UTC (rev 96611)
@@ -0,0 +1,84 @@
+<SECTION>
+<FILE>WebKitWebViewBase</FILE>
+<TITLE>WebKitWebViewBase</TITLE>
+WebKitWebViewBase
+<SUBSECTION Standard>
+WebKitWebViewBaseClass
+WEBKIT_WEB_VIEW_BASE
+WEBKIT_IS_WEB_VIEW_BASE
+WEBKIT_TYPE_WEB_VIEW_BASE
+WEBKIT_WEB_VIEW_BASE_CLASS
+WEBKIT_IS_WEB_VIEW_BASE_CLASS
+WEBKIT_WEB_VIEW_BASE_GET_CLASS
+<SUBSECTION Private>
+webkit_web_view_base_get_type
+WebKitWebViewBasePrivate
+</SECTION>
+
+<SECTION>
+<FILE>WebKitWebContext</FILE>
+<TITLE>WebKitWebContext</TITLE>
+WebKitWebContext
+webkit_web_context_get_default
+<SUBSECTION Standard>
+WebKitWebContextClass
+WEBKIT_WEB_CONTEXT
+WEBKIT_IS_WEB_CONTEXT
+WEBKIT_TYPE_WEB_CONTEXT
+WEBKIT_WEB_CONTEXT_CLASS
+WEBKIT_IS_WEB_CONTEXT_CLASS
+WEBKIT_WEB_CONTEXT_GET_CLASS
+<SUBSECTION Private>
+WebKitWebContextPrivate
+webkit_web_context_get_type
+</SECTION>
+
+<SECTION>
+<FILE>WebKitWebView</FILE>
+<TITLE>WebKitWebView</TITLE>
+WebKitWebView
+webkit_web_view_new
+webkit_web_view_new_with_context
+webkit_web_view_get_context
+webkit_web_view_get_loader_client
+webkit_web_view_set_loader_client
+webkit_web_view_load_uri
+webkit_web_view_go_back
+webkit_web_view_go_forward
+<SUBSECTION Standard>
+WebKitWebViewClass
+WEBKIT_WEB_VIEW
+WEBKIT_IS_WEB_VIEW
+WEBKIT_TYPE_WEB_VIEW
+WEBKIT_WEB_VIEW_CLASS
+WEBKIT_IS_WEB_VIEW_CLASS
+WEBKIT_WEB_VIEW_GET_CLASS
+<SUBSECTION Private>
+webkit_web_view_get_type
+WebKitWebViewPrivate
+</SECTION>
+
+<SECTION>
+<FILE>WebKitWebLoaderClient</FILE>
+<TITLE>WebKitWebLoaderClient</TITLE>
+WebKitWebLoaderClient
+<SUBSECTION Standard>
+WebKitWebLoaderClientClass
+WEBKIT_WEB_LOADER_CLIENT
+WEBKIT_IS_WEB_LOADER_CLIENT
+WEBKIT_TYPE_WEB_LOADER_CLIENT
+WEBKIT_WEB_LOADER_CLIENT_CLASS
+WEBKIT_IS_WEB_LOADER_CLIENT_CLASS
+WEBKIT_WEB_LOADER_CLIENT_GET_CLASS
+<SUBSECTION Private>
+WebKitWebLoaderClientPrivate
+webkit_web_loader_client_get_type
+</SECTION>
+
+<SECTION>
+<FILE>WebKitError</FILE>
+WEBKIT_NETWORK_ERROR
+WebKitNetworkError
+webkit_network_error_quark
+</SECTION>
+
Added: trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk.types (0 => 96611)
--- trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk.types (rev 0)
+++ trunk/Source/WebKit2/UIProcess/API/gtk/docs/webkit2gtk.types 2011-10-04 18:02:41 UTC (rev 96611)
@@ -0,0 +1,5 @@
+#include <webkit2/webkit2.h>
+webkit_web_view_get_type
+webkit_web_view_base_get_type
+webkit_web_loader_client_get_type
+webkit_web_context_get_type
Modified: trunk/configure.ac (96610 => 96611)
--- trunk/configure.ac 2011-10-04 18:00:32 UTC (rev 96610)
+++ trunk/configure.ac 2011-10-04 18:02:41 UTC (rev 96611)
@@ -1181,6 +1181,8 @@
Source/WebKit/gtk/webkit/webkitversion.h
Source/WebKit/gtk/docs/GNUmakefile
Source/WebKit/gtk/docs/version.xml
+Source/WebKit2/UIProcess/API/gtk/docs/GNUmakefile
+Source/WebKit2/UIProcess/API/gtk/docs/version.xml
])
AC_CONFIG_FILES([
