[maemo-commits] [maemo-commits] r13081 - in projects/haf/trunk/hildon-desktop: . doc
From: subversion at stage.maemo.org subversion at stage.maemo.orgDate: Thu Aug 9 15:36:16 EEST 2007
- Previous message: [maemo-commits] r13080 - in projects/haf/trunk/hildon-theme-layout-4: . rc
- Next message: [maemo-commits] r13083 - in projects/connectivity/osso-bluez-compat/trunk: . debian etc
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Author: jobi Date: 2007-08-09 15:36:14 +0300 (Thu, 09 Aug 2007) New Revision: 13081 Added: projects/haf/trunk/hildon-desktop/doc/ projects/haf/trunk/hildon-desktop/doc/Makefile.am projects/haf/trunk/hildon-desktop/doc/gtk-doc.make projects/haf/trunk/hildon-desktop/doc/hildon-desktop.types Modified: projects/haf/trunk/hildon-desktop/ChangeLog projects/haf/trunk/hildon-desktop/Makefile.am projects/haf/trunk/hildon-desktop/configure.ac Log: 2007-08-09 Johan Bilien <johan.bilien at nokia.com> * doc/*: first attempt at getting gtkdoc working Modified: projects/haf/trunk/hildon-desktop/ChangeLog =================================================================== --- projects/haf/trunk/hildon-desktop/ChangeLog 2007-08-09 11:54:07 UTC (rev 13080) +++ projects/haf/trunk/hildon-desktop/ChangeLog 2007-08-09 12:36:14 UTC (rev 13081) @@ -1,3 +1,7 @@ +2007-08-09 Johan Bilien <johan.bilien at nokia.com> + + * doc/*: first attempt at getting gtkdoc working + 2007-08-09 Lucas Rocha <lucas.rocha at nokia.com> * src/hd-switcher-menu.c: changed switcher menu icon size to 40px. Modified: projects/haf/trunk/hildon-desktop/Makefile.am =================================================================== --- projects/haf/trunk/hildon-desktop/Makefile.am 2007-08-09 11:54:07 UTC (rev 13080) +++ projects/haf/trunk/hildon-desktop/Makefile.am 2007-08-09 12:36:14 UTC (rev 13081) @@ -1,3 +1,3 @@ -SUBDIRS = data libhildonwm libhildondesktop background-manager src policies +SUBDIRS = data libhildonwm libhildondesktop background-manager src policies doc CLEANFILES = *~ Modified: projects/haf/trunk/hildon-desktop/configure.ac =================================================================== --- projects/haf/trunk/hildon-desktop/configure.ac 2007-08-09 11:54:07 UTC (rev 13080) +++ projects/haf/trunk/hildon-desktop/configure.ac 2007-08-09 12:36:14 UTC (rev 13081) @@ -24,6 +24,8 @@ AC_PATH_PROG(GLIB_GENMARSHAL, glib-genmarshal) AC_PATH_PROG(DBUS_BINDING_TOOL, dbus-binding-tool) +GTK_DOC_CHECK([1.3]) + #++++++++++++++++++ # Misc build flags #++++++++++++++++++ @@ -285,4 +287,5 @@ data/applications-menu.desktop data/switcher-menu.desktop policies/Makefile +doc/Makefile ]) Added: projects/haf/trunk/hildon-desktop/doc/Makefile.am =================================================================== --- projects/haf/trunk/hildon-desktop/doc/Makefile.am 2007-08-09 11:54:07 UTC (rev 13080) +++ projects/haf/trunk/hildon-desktop/doc/Makefile.am 2007-08-09 12:36:14 UTC (rev 13081) @@ -0,0 +1,46 @@ +MAINTAINERCLEANFILES = Makefile.in \ + hildon-desktop-sections.txt \ + hildon-desktop-undocumented.txt \ + version.xml \ + tmpl/*.sgml + +DOC_MODULE = hildon-desktop + +DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml + +SCAN_OPTIONS = + +SCANOBJ_OPTIONS =--type-init-func="gtk_type_init(0)" + +DOC_SOURCE_DIR = $(top_srcdir)/libhildondesktop +DOC_BUILD_DIR = $(top_builddir)/libhildondesktop + + +HFILE_GLOB = $(top_srcdir)/libhildondesktop/*.h + +CFILE_GLOB = $(top_srcdir)/libhildondesktop/*.c + +#IGNORE_HFILES = hildon-banner-private.h + +INCLUDES = $(GTK_CFLAGS) $(HILDON_CFLAGS) -I$(top_srcdir) + +MKDB_OPTIONS = --sgml-mode --output-format=xml + +content_files = version.xml +# visual_index.xml + +GTKDOC_CFLAGS = $(HILDON_CFLAGS) + +GTKDOC_LIBS = $(HILDON_LIBS) + +HTML_IMAGES = + +version.xml: ../configure.ac + @echo $(VERSION) > version.xml + +html: html-build.stamp + +FIXXREF_OPTIONS = + +include $(top_srcdir)/doc/gtk-doc.make + Added: projects/haf/trunk/hildon-desktop/doc/gtk-doc.make =================================================================== --- projects/haf/trunk/hildon-desktop/doc/gtk-doc.make 2007-08-09 11:54:07 UTC (rev 13080) +++ projects/haf/trunk/hildon-desktop/doc/gtk-doc.make 2007-08-09 12:36:14 UTC (rev 13081) @@ -0,0 +1,155 @@ +# -*- mode: makefile -*- + +#################################### +# Everything below here is generic # +#################################### + +if GTK_DOC_USE_LIBTOOL +GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS) +GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS) +else +GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS) +GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(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 + +CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(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 + +#### 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 + +maintainer-clean-local: clean + cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + +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) || :; \ + 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 + if test -f $(srcdir)/$(DOC_MODULE).types; then \ + cp $(srcdir)/$(DOC_MODULE).types $(distdir)/$(DOC_MODULE).types; \ + fi + +.PHONY : dist-hook-local docs Added: projects/haf/trunk/hildon-desktop/doc/hildon-desktop.types =================================================================== --- projects/haf/trunk/hildon-desktop/doc/hildon-desktop.types 2007-08-09 11:54:07 UTC (rev 13080) +++ projects/haf/trunk/hildon-desktop/doc/hildon-desktop.types 2007-08-09 12:36:14 UTC (rev 13081) @@ -0,0 +1,6 @@ +#include <libhildondesktop/hildon-desktop-item.h> +#include <libhildondesktop/hildon-desktop-home-item.h> +#include <libhildondesktop/hildon-desktop-panel-item.h> +#include <libhildondesktop/statusbar-item.h> +#include <libhildondesktop/tasknavigator-item.h> +
- Previous message: [maemo-commits] r13080 - in projects/haf/trunk/hildon-theme-layout-4: . rc
- Next message: [maemo-commits] r13083 - in projects/connectivity/osso-bluez-compat/trunk: . debian etc
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]