[maemo-commits] [maemo-commits] r14484 - in projects/haf/branches/hildon-help/gtk-doc: . debian reference

Wed Oct 17 19:41:44 EEST 2007

Author: schulhof
Date: 2007-10-17 19:41:42 +0300 (Wed, 17 Oct 2007)
New Revision: 14484

Added:
   projects/haf/branches/hildon-help/gtk-doc/reference/
   projects/haf/branches/hildon-help/gtk-doc/reference/Makefile.am
   projects/haf/branches/hildon-help/gtk-doc/reference/hildon-help-docs.sgml
   projects/haf/branches/hildon-help/gtk-doc/reference/hildon-help-sections.txt
Removed:
   projects/haf/branches/hildon-help/gtk-doc/autogen.sh
   projects/haf/branches/hildon-help/gtk-doc/doc/
Modified:
   projects/haf/branches/hildon-help/gtk-doc/Makefile.am
   projects/haf/branches/hildon-help/gtk-doc/configure.ac
   projects/haf/branches/hildon-help/gtk-doc/debian/control
   projects/haf/branches/hildon-help/gtk-doc/debian/rules
Log:
Initial gtk-doc support.


Modified: projects/haf/branches/hildon-help/gtk-doc/Makefile.am
===================================================================

--- projects/haf/branches/hildon-help/gtk-doc/Makefile.am	2007-10-17 14:03:29 UTC (rev 14483)
+++ projects/haf/branches/hildon-help/gtk-doc/Makefile.am	2007-10-17 16:41:42 UTC (rev 14484)
@@ -15,7 +15,7 @@
 	     debian/libhildonhelp0.links \
 	     debian/rules
 
-SUBDIRS = src helptest
+SUBDIRS = src helptest reference
 
 INCLUDES = $(DEPS_CFLAGS)
 

Deleted: projects/haf/branches/hildon-help/gtk-doc/autogen.sh
===================================================================
--- projects/haf/branches/hildon-help/gtk-doc/autogen.sh	2007-10-17 14:03:29 UTC (rev 14483)
+++ projects/haf/branches/hildon-help/gtk-doc/autogen.sh	2007-10-17 16:41:42 UTC (rev 14484)
@@ -1,12 +0,0 @@
-#!/bin/sh
-# Script for running GNU toolchain for configuration
-set -x
-glib-gettextize --copy --force
-libtoolize --automake --copy
-intltoolize --copy --force --automake
-aclocal-1.8
-autoconf
-autoheader
-automake-1.8 --add-missing --foreign --copy --force
-./configure --prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info --with-doc-dir=/usr/share/doc --disable-dependency-tracking --disable-gtk-doc
-

Modified: projects/haf/branches/hildon-help/gtk-doc/configure.ac
===================================================================
--- projects/haf/branches/hildon-help/gtk-doc/configure.ac	2007-10-17 14:03:29 UTC (rev 14483)
+++ projects/haf/branches/hildon-help/gtk-doc/configure.ac	2007-10-17 16:41:42 UTC (rev 14484)
@@ -59,13 +59,15 @@
 AC_SUBST(dbusconfdir)
 AC_SUBST(dbusservdir)
 
+GTK_DOC_CHECK(1.4)
+
 # Define output files
 AC_CONFIG_FILES([
   Makefile
   src/Makefile
   src/hildon-help.pc
+  reference/Makefile
   helptest/Makefile
-  doc/Doxyfile
 ])
 
 # Mandatory, produce output

Modified: projects/haf/branches/hildon-help/gtk-doc/debian/control
===================================================================
--- projects/haf/branches/hildon-help/gtk-doc/debian/control	2007-10-17 14:03:29 UTC (rev 14483)
+++ projects/haf/branches/hildon-help/gtk-doc/debian/control	2007-10-17 16:41:42 UTC (rev 14484)
@@ -13,6 +13,14 @@
  Development files for HelpLib; access and controlling
  Hildon Help from other applications.
 
+Package: libhildonhelp-doc
+Section: doc
+Architecture: all
+Depends: lynx | www-browser
+Suggests: libglib2.0-doc, libatk1.0-doc, libpango1.0-doc, libgtk2.0-doc
+Description: Hildon HelpLib for application developers
+ Documentation for hildon-help
+
 Package: libhildonhelp0
 Section: misc
 Architecture: any

Modified: projects/haf/branches/hildon-help/gtk-doc/debian/rules
===================================================================
--- projects/haf/branches/hildon-help/gtk-doc/debian/rules	2007-10-17 14:03:29 UTC (rev 14483)
+++ projects/haf/branches/hildon-help/gtk-doc/debian/rules	2007-10-17 16:41:42 UTC (rev 14484)
@@ -20,10 +20,17 @@
 else
 	CFLAGS += -O2
 endif
+
 ifeq (,$(findstring nostrip,$(DEB_BUILD_OPTIONS)))
 	INSTALL_PROGRAM += -s
 endif
 
+ifeq (,$(findstring nodocs,$(DEB_BUILD_OPTIONS)))
+	GTK_DOC_CONFIGURE_SWITCH=--enable-gtk-doc
+else
+	GTK_DOC_CONFIGURE_SWITCH=--disable-gtk-doc
+endif
+
 # shared library versions, option 1
 version=2.0.5
 major=2
@@ -36,22 +43,36 @@
 config.status: configure
 	dh_testdir
 	# Add here commands to configure the package.
-	CFLAGS="$(CFLAGS)" ./configure --host=$(DEB_HOST_GNU_TYPE) --build=$(DEB_BUILD_GNU_TYPE) --prefix=/usr --mandir=\$${prefix}/share/man --infodir=\$${prefix}/share/info --with-doc-dir=\$${prefix}/share/doc --disable-dependency-tracking --disable-gtk-doc
+	CFLAGS="$(CFLAGS)" ./configure \
+		--host=$(DEB_HOST_GNU_TYPE) \
+		--build=$(DEB_BUILD_GNU_TYPE) \
+		--prefix=/usr \
+		--mandir=\$${prefix}/share/man \
+		--infodir=\$${prefix}/share/info \
+		--with-doc-dir=\$${prefix}/share/doc \
+		--disable-dependency-tracking \
+		$(GTK_DOC_CONFIGURE_SWITCH)
 
 configure:
+	./check-gtk-doc
 	libtoolize --automake
 	aclocal-1.7 || aclocal
 	autoconf
 	autoheader
-	automake-1.7 --add-missing --foreign || automake --add-missing> --foreign
+	automake-1.7 --add-missing --foreign || automake --add-missing --foreign
 
 build: build-stamp
 build-stamp:  config.status
 	dh_testdir
 
 	# Add here commands to compile the package.
+	$(MAKE) -C reference || true /* This fails the first time */
 	$(MAKE)
+	$(MAKE) -C reference webdocs
 
+	rm -rf reference/html
+	mv reference/html-web reference/html
+
 	touch build-stamp
 
 clean:
@@ -60,6 +81,7 @@
 	rm -f build-stamp 
 
 	# Add here commands to clean up after the build process.
+	-$(MAKE) -C reference deepclean
 	-$(MAKE) distclean
 ifneq "$(wildcard /usr/share/misc/config.sub)" ""
 	cp -f /usr/share/misc/config.sub config.sub

Added: projects/haf/branches/hildon-help/gtk-doc/reference/Makefile.am
===================================================================
--- projects/haf/branches/hildon-help/gtk-doc/reference/Makefile.am	2007-10-17 14:03:29 UTC (rev 14483)
+++ projects/haf/branches/hildon-help/gtk-doc/reference/Makefile.am	2007-10-17 16:41:42 UTC (rev 14484)
@@ -0,0 +1,125 @@
+## Process this file with automake to produce Makefile.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=hildon-help
+
+# 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=../src
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=--type-init-func=MY_INIT_FUNC
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# 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=$(DOC_SOURCE_DIR)/*.h
+CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=
+
+# 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=
+GTKDOC_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 += 
+
+GNOME_DEV_HOME = https://stage.maemo.org/svn/maemo/projects/haf/doc/api
+
+# Things to do to make the gtk-doc-generated HTML Web-friendly:
+# 1. Replace all hrefs of the form href="/usr/share/doc/gtk-doc with
+#    hrefs of the form href="http://developer.gnome.org/doc/API/2.0
+#    This is accomplished by the first sed's first "-e"
+# 2. Insert the shortcut icon before </head>
+#    This is accomplished by the first sed's second "-e"
+# 3. Find the last occurrence of </div> and replace it with
+#    <the comments necessary to produce the "Last Modified:" message></div>
+#    This is accomplished by reversing the order of lines in the file with
+#    "tac" and replacing the /first/ occurrence of </div> as described, and
+#    then reversing the order of lines again with another "tac"
+#    Tasks 1. and 2. are unaffected by these reversals
+webdocs: all
+	echo "$(prefix)"
+	rm -rf html-web
+	mkdir -p html-web
+	for file in `find html`; do \
+	  ROOT_PATH=`echo $${file} | sed 's/^html//'`; \
+	  if test "" != "$${ROOT_PATH}"; then \
+	    if test -d $$file; then \
+	      echo "Creating directory html-web$${ROOT_PATH}..."; \
+	      mkdir -p html-web$${ROOT_PATH}; \
+	    else \
+	      if echo $$file | grep -q '\.html$$'; then \
+	        echo "Creating file html-web$${ROOT_PATH}..."; \
+	        tac $$file \
+	          | sed -r \
+	            -e 's!href="(/usr/share/gtk-doc/html|\.\.)!href="$(GNOME_DEV_HOME)!g' \
+	          | tac \
+	          > html-web$${ROOT_PATH}; \
+	      else \
+	        echo "Copying file html-web$${ROOT_PATH}..."; \
+	        cp $$file html-web$${ROOT_PATH}; \
+	      fi \
+	    fi; \
+	  fi; \
+	done
+
+deepclean: clean
+	rm -rf \
+	  $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt $(DOC_MODULE)-overrides.txt $(DOC_MODULE)-undocumented.txt \
+	  $(DOC_MODULE)-unused.txt $(DOC_MODULE).args $(DOC_MODULE).hierarchy $(DOC_MODULE).interfaces \
+	  $(DOC_MODULE).prerequisites $(DOC_MODULE).signals html html-build.stamp html-web html.stamp scan-build.stamp \
+	  sgml-build.stamp sgml.stamp tmpl tmpl-build.stamp tmpl.stamp xml

Added: projects/haf/branches/hildon-help/gtk-doc/reference/hildon-help-docs.sgml
===================================================================
--- projects/haf/branches/hildon-help/gtk-doc/reference/hildon-help-docs.sgml	2007-10-17 14:03:29 UTC (rev 14483)
+++ projects/haf/branches/hildon-help/gtk-doc/reference/hildon-help-docs.sgml	2007-10-17 16:41:42 UTC (rev 14484)
@@ -0,0 +1,15 @@
+<?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">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>hildon-help Reference Manual</title>
+  </bookinfo>
+
+  <chapter>
+    <title>hildon-help</title>
+    <xi:include href="xml/hildon-help-private.xml"/>
+    <xi:include href="xml/internal.xml"/>
+    <xi:include href="xml/hildon-help.xml"/>
+  </chapter>
+</book>

Added: projects/haf/branches/hildon-help/gtk-doc/reference/hildon-help-sections.txt
===================================================================
--- projects/haf/branches/hildon-help/gtk-doc/reference/hildon-help-sections.txt	2007-10-17 14:03:29 UTC (rev 14483)
+++ projects/haf/branches/hildon-help/gtk-doc/reference/hildon-help-sections.txt	2007-10-17 16:41:42 UTC (rev 14484)
@@ -0,0 +1,77 @@
+<SECTION>
+<FILE>hildon-help-private</FILE>
+HELP_HTML_TMPFILE
+OSSO_HELP_PATH
+OSSO_HELP_CSS
+DEFAULT_CSS
+HELPLIB_PICTURE_PATHS
+HELPLIB_PICTURE_EXTENSIONS
+HELPLIB_ICO_PATH
+HELP_KEY_MAXLEN
+HELP_TITLE_MAXLEN
+HELP_KEY_OR_TITLE_MAXLEN
+HELP_DIALOG_WIDTH
+HELP_DIALOG_HEIGHT
+HELPUI_DOMAIN
+ossohelp_getpath
+ossohelp_getcss
+s_help_trail
+ossohelp_html_ext
+ossohelp_file
+ossohelp_title
+key_from_triplet
+helplib_ui_str
+last_char
+strcpy_safe_max
+strcat_safe_max
+strcpy_safe
+strcat_safe
+strcpy_safe_auto
+strcat_safe_auto
+strcpy_safe_auto_max
+strcat_safe_auto_max
+h_OssoHelpWalker
+ossohelp_next
+ossohelp_link_clicked
+browser_new
+browser_close
+browser_show
+browser_zoom
+browser_find
+browser_has_selection
+browser_copy_selection
+libosso_update_html
+browser_focus_forward_backward
+browser_has_focus
+</SECTION>
+
+<SECTION>
+<FILE>internal</FILE>
+fexists
+helplib_str_close
+helplib_str_title
+ossohelp_file2
+s_OssoHelpWalker
+contents
+filter
+title_from_key
+context
+graphic_tag
+filter_outf
+dialog_mode
+loc_getattr_count
+loc_getattr
+filter_characters_cb
+filter_startElement_cb
+filter_endElement_cb
+init_filter_html
+key_from_triplet
+system_dialog
+</SECTION>
+
+<SECTION>
+<FILE>hildon-help</FILE>
+hildon_help_show
+hildon_help_dialog_help_enable
+</SECTION>
+


