bonobo: add gtk-doc files

Signed-off-by: Koen Kooi <koen@dominion.thruhere.net>

2 files changed, 226 insertions, 0 deletions

diff --git a/meta-gnome/recipes-gnome/bonobo/files/gtk-doc.m4 b/meta-gnome/recipes-gnome/bonobo/files/gtk-doc.m4
new file mode 100644
index 000000000..3ec41666b
--- /dev/null
+++ b/meta-gnome/recipes-gnome/bonobo/files/gtk-doc.m4
@@ -0,0 +1,53 @@
+dnl -*- mode: autoconf -*-
+
+# serial 1
+
+dnl Usage:
+dnl   GTK_DOC_CHECK([minimum-gtk-doc-version])
+AC_DEFUN([GTK_DOC_CHECK],
+[
+  AC_BEFORE([AC_PROG_LIBTOOL],[$0])dnl setup libtool first
+  AC_BEFORE([AM_PROG_LIBTOOL],[$0])dnl setup libtool first
+  dnl for overriding the documentation installation directory
+  AC_ARG_WITH(html-dir,
+    AC_HELP_STRING([--with-html-dir=PATH], [path to installed docs]),,
+    [with_html_dir='${datadir}/gtk-doc/html'])
+  HTML_DIR="$with_html_dir"
+  AC_SUBST(HTML_DIR)
+
+  dnl enable/disable documentation building
+  AC_ARG_ENABLE(gtk-doc,
+    AC_HELP_STRING([--enable-gtk-doc],
+                   [use gtk-doc to build documentation [default=no]]),,
+    enable_gtk_doc=no)
+
+  have_gtk_doc=no
+  if test -z "$PKG_CONFIG"; then
+    AC_PATH_PROG(PKG_CONFIG, pkg-config, no)
+  fi
+  if test "$PKG_CONFIG" != "no" && $PKG_CONFIG --exists gtk-doc; then
+    have_gtk_doc=yes
+  fi
+
+  dnl do we want to do a version check?
+ifelse([$1],[],,
+  [gtk_doc_min_version=$1
+  if test "$have_gtk_doc" = yes; then
+    AC_MSG_CHECKING([gtk-doc version >= $gtk_doc_min_version])
+    if $PKG_CONFIG --atleast-version $gtk_doc_min_version gtk-doc; then
+      AC_MSG_RESULT(yes)
+    else
+      AC_MSG_RESULT(no)
+      have_gtk_doc=no
+    fi
+  fi
+])
+  if test x$enable_gtk_doc = xyes; then
+    if test "$have_gtk_doc" != yes; then
+      enable_gtk_doc=no
+    fi
+  fi
+
+  AM_CONDITIONAL(ENABLE_GTK_DOC, test x$enable_gtk_doc = xyes)
+  AM_CONDITIONAL(GTK_DOC_USE_LIBTOOL, test -n "$LIBTOOL")
+])
diff --git a/meta-gnome/recipes-gnome/bonobo/files/gtk-doc.make b/meta-gnome/recipes-gnome/bonobo/files/gtk-doc.make
new file mode 100644
index 000000000..354ffb7c6
--- /dev/null
+++ b/meta-gnome/recipes-gnome/bonobo/files/gtk-doc.make
@@ -0,0 +1,173 @@
+# -*- mode: makefile -*-
+
+####################################
+# Everything below here is generic #
+####################################
+
+if GTK_DOC_USE_LIBTOOL
+GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
+GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
+else
+GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
+GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
+endif
+
+# We set GPATH here; this gives us semantics for GNU make
+# which are more like other make's VPATH, when it comes to
+# whether a source that is a target of one rule is then
+# searched for in VPATH/GPATH.
+#
+GPATH = $(srcdir)
+
+TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+
+EXTRA_DIST =                            \
+        $(content_files)                \
+        $(HTML_IMAGES)                  \
+        $(DOC_MAIN_SGML_FILE)           \
+        $(DOC_MODULE)-sections.txt      \
+        $(DOC_MODULE)-overrides.txt
+
+DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
+           $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
+
+SCANOBJ_FILES =                  \
+        $(DOC_MODULE).args       \
+        $(DOC_MODULE).hierarchy  \
+        $(DOC_MODULE).interfaces \
+        $(DOC_MODULE).prerequisites \
+        $(DOC_MODULE).signals
+
+REPORT_FILES = \
+        $(DOC_MODULE)-undocumented.txt \
+        $(DOC_MODULE)-undeclared.txt \
+        $(DOC_MODULE)-unused.txt
+
+CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
+
+if ENABLE_GTK_DOC
+all-local: html-build.stamp
+else
+all-local:
+endif
+
+docs: html-build.stamp
+
+#### scan ####
+
+scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
+        @echo 'gtk-doc: Scanning header files'
+        @-chmod -R u+w $(srcdir)
+        cd $(srcdir) && \
+          gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
+        if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
+            CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
+        else \
+            cd $(srcdir) ; \
+            for i in $(SCANOBJ_FILES) ; do \
+               test -f $$i || touch $$i ; \
+            done \
+        fi
+        touch scan-build.stamp
+
+$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
+        @true
+
+#### templates ####
+
+tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
+        @echo 'gtk-doc: Rebuilding template files'
+        @-chmod -R u+w $(srcdir)
+        cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
+        touch tmpl-build.stamp
+
+tmpl.stamp: tmpl-build.stamp
+        @true
+
+tmpl/*.sgml:
+        @true
+
+
+#### xml ####
+
+sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
+        @echo 'gtk-doc: Building XML'
+        @-chmod -R u+w $(srcdir)
+        cd $(srcdir) && \
+        gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
+        touch sgml-build.stamp
+
+sgml.stamp: sgml-build.stamp
+        @true
+
+#### html ####
+
+html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
+        @echo 'gtk-doc: Building HTML'
+        @-chmod -R u+w $(srcdir)
+        rm -rf $(srcdir)/html
+        mkdir $(srcdir)/html
+        cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
+        test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
+        @echo 'gtk-doc: Fixing cross-references'
+        cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
+        touch html-build.stamp
+
+##############
+
+clean-local:
+        rm -f *~ *.bak
+        rm -rf .libs
+
+distclean-local:
+        cd $(srcdir) && \
+          rm -rf xml $(REPORT_FILES) \
+                 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
+
+maintainer-clean-local: clean
+        cd $(srcdir) && rm -rf xml html
+
+install-data-local:
+        -installfiles=`echo $(srcdir)/html/*`; \
+        if test "$$installfiles" = '$(srcdir)/html/*'; \
+        then echo '-- Nothing to install' ; \
+        else \
+          $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
+          for i in $$installfiles; do \
+            echo '-- Installing '$$i ; \
+            $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
+          done; \
+          echo '-- Installing $(srcdir)/html/index.sgml' ; \
+          $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \
+          which gtkdoc-rebase >/dev/null && \
+            gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR) ; \
+        fi
+        
+
+uninstall-local:
+        rm -f $(DESTDIR)$(TARGET_DIR)/*
+
+#
+# Require gtk-doc when making dist
+#
+if ENABLE_GTK_DOC
+dist-check-gtkdoc:
+else
+dist-check-gtkdoc:
+        @echo "*** gtk-doc must be installed and enabled in order to make dist"
+        @false
+endif
+
+dist-hook: dist-check-gtkdoc dist-hook-local
+        mkdir $(distdir)/tmpl
+        mkdir $(distdir)/xml
+        mkdir $(distdir)/html
+        -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
+        -cp $(srcdir)/xml/*.xml $(distdir)/xml
+        cp $(srcdir)/html/* $(distdir)/html
+        -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
+        -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
+        cd $(distdir) && rm -f $(DISTCLEANFILES)
+        -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
+
+.PHONY : dist-hook-local docs