[maemo-commits] [maemo-commits] r10739 - in projects/haf/trunk/hildon-fm: . doc
From: subversion at stage.maemo.org subversion at stage.maemo.orgDate: Fri Mar 23 13:36:16 EET 2007
- Previous message: [maemo-commits] r10738 - projects/haf/trunk/hildon-fm
- Next message: [maemo-commits] r10740 - projects/haf/trunk/hildon-desktop/debian
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]
Author: tko Date: 2007-03-23 13:36:15 +0200 (Fri, 23 Mar 2007) New Revision: 10739 Added: projects/haf/trunk/hildon-fm/doc/gtk-doc.make Modified: projects/haf/trunk/hildon-fm/ChangeLog projects/haf/trunk/hildon-fm/configure.ac projects/haf/trunk/hildon-fm/doc/Makefile.am projects/haf/trunk/hildon-fm/doc/hildon-fm-docs.xml projects/haf/trunk/hildon-fm/doc/hildon-fm.types Log: API documentation updates. 2007-03-23 Tommi Komulainen <tommi.komulainen at nokia.com> * configure.ac: Remove the manual check for gtk-doc and use GTK_DOC_CHECK instead * doc/hildon-fm.types: Add hildon_file_details_dialog_get_type * doc/hildon-fm-docs.xml: Add 'Object Hierarchy', indices and missing public API docs for file details dialog and file system info. The rest of xml files are for private APIs. * doc/gtk-doc.make: Copy from gtk-doc 1.7 and fix '*.sgml' prerequisite with $(wildcard) to work in absence of any files. * doc/Makefile.am: Remove inlined gtk-doc.make bits and update to gtk-doc 1.7. Define deprecation guards. Update MAINTAINERCLEANFILES. Modified: projects/haf/trunk/hildon-fm/ChangeLog =================================================================== --- projects/haf/trunk/hildon-fm/ChangeLog 2007-03-23 11:27:20 UTC (rev 10738) +++ projects/haf/trunk/hildon-fm/ChangeLog 2007-03-23 11:36:15 UTC (rev 10739) @@ -1,5 +1,18 @@ 2007-03-23 Tommi Komulainen <tommi.komulainen at nokia.com> + * configure.ac: Remove the manual check for gtk-doc and use + GTK_DOC_CHECK instead + * doc/hildon-fm.types: Add hildon_file_details_dialog_get_type + * doc/hildon-fm-docs.xml: Add 'Object Hierarchy', indices and missing + public API docs for file details dialog and file system info. The rest + of xml files are for private APIs. + * doc/gtk-doc.make: Copy from gtk-doc 1.7 and fix '*.sgml' + prerequisite with $(wildcard) to work in absence of any files. + * doc/Makefile.am: Remove inlined gtk-doc.make bits and update to + gtk-doc 1.7. Define deprecation guards. Update MAINTAINERCLEANFILES. + +2007-03-23 Tommi Komulainen <tommi.komulainen at nokia.com> + * Makefile.am (MAINTAINERCLEANFILES): Added to clean up cruft 2007-03-09 Marius Vollmer <marius.vollmer at nokia.com> Modified: projects/haf/trunk/hildon-fm/configure.ac =================================================================== --- projects/haf/trunk/hildon-fm/configure.ac 2007-03-23 11:27:20 UTC (rev 10738) +++ projects/haf/trunk/hildon-fm/configure.ac 2007-03-23 11:36:15 UTC (rev 10739) @@ -67,61 +67,10 @@ ################################################## # Check for gtk-doc. ################################################## +GTK_DOC_CHECK -AC_ARG_WITH(html-dir, [ --with-html-dir=PATH path to installed docs ]) - -if test "x$with_html_dir" = "x" ; then - HTML_DIR='${datadir}/gtk-doc/html' -else - HTML_DIR=$with_html_dir -fi - -AC_CHECK_PROG(GTKDOC, gtkdoc-mkdb, true, false) - -gtk_doc_min_version=0.10 -if $GTKDOC ; then - gtk_doc_version=`gtkdoc-mkdb --version` - AC_MSG_CHECKING([gtk-doc version ($gtk_doc_version) >= $gtk_doc_min_version] -) - if perl <<EOF ; then - exit (("$gtk_doc_version" =~ /^[[0-9]]+\.[[0-9]]+$/) && - ("$gtk_doc_version" >= "$gtk_doc_min_version") ? 0 : 1); -EOF - AC_MSG_RESULT(yes) - else - AC_MSG_RESULT(no) - GTKDOC=false - fi -fi - -dnl Let people disable the gtk-doc stuff. -AC_ARG_ENABLE(gtk-doc, [ --enable-gtk-doc use gtk-doc to build documenta -tion [default=yes]], enable_gtk_doc="$enableval", enable_gtk_doc=yes) - -if test x$enable_gtk_doc = xauto ; then - if test x$GTKDOC = xtrue ; then - enable_gtk_doc=yes - else - enable_gtk_doc=no - fi -fi - -AM_CONDITIONAL(ENABLE_GTK_DOC, test x$enable_gtk_doc = xyes) - outomoduledir=${libdir}/outo - -AC_ARG_ENABLE(doc-dir, [ --with-doc-dir=PATH path to installed docs ]) -if test "x$with_doc_dir" = "x" ; then - docdir='${datadir}/doc' -else - docdir=$with_doc_dir -fi - -HTML_DIR=${docdir}/html - -AC_SUBST(docdir) AC_SUBST(outomoduledir) -AC_SUBST(HTML_DIR) # Disable rebuild of glib-mkenum -generated source code: Modified: projects/haf/trunk/hildon-fm/doc/Makefile.am =================================================================== --- projects/haf/trunk/hildon-fm/doc/Makefile.am 2007-03-23 11:27:20 UTC (rev 10738) +++ projects/haf/trunk/hildon-fm/doc/Makefile.am 2007-03-23 11:36:15 UTC (rev 10739) @@ -11,189 +11,42 @@ # The top-level SGML file. Change it if you want. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml -# The directory containing the source code. Relative to $(srcdir). -# gtk-doc will search all .c & .h files beneath here for inline comments -# documenting functions and macros. -DOC_SOURCE_DIR=../hildon-fm +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS=--deprecated-guards="HILDON_DISABLE_DEPRECATED" # Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj. SCANOBJ_OPTIONS=--type-init-func="gtk_type_init(0)" -# Extra options to supply to gtkdoc-scan. -SCAN_OPTIONS= +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. +DOC_SOURCE_DIR=$(top_srcdir)/hildon-fm -# Header files to ignore when scanning. -IGNORE_HFILES=*private* config.h ut md5.h - -# Files to ignore when making the DB. -IGNORE_FILES=$(IGNORE_HFILES) - -# Extra options to supply to gtkdoc-mkdb. -MKDB_OPTIONS=--ignore-files="$(IGNORE_FILES)" --sgml-mode --output-format=xml - -# Extra options to supply to gtkdoc-fixref. -FIXXREF_OPTIONS= - # Used for dependencies. HFILE_GLOB=$(top_srcdir)/hildon-fm/*.h CFILE_GLOB=$(top_srcdir)/hildon-fm/*.c +# Header files to ignore when scanning. +IGNORE_HFILES=*private* config.h ut md5.h +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS=--sgml-mode --output-format=xml -# Images to copy into HTML directory. -HTML_IMAGES = - # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). content_files = -# Other files to distribute. -extra_files = - # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib # contains GtkObjects/GObjects and you want to document signals and properties. GTKDOC_CFLAGS = $(GTK_CFLAGS) -I$(top_srcdir) -I$(top_srcdir)/hildon-fm GTKDOC_LIBS = $(GTK_LIBS) ../hildon-fm/libhildonfm.la -GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) -GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) +# Images to copy into HTML directory. +HTML_IMAGES = -# If you need to override some of the declarations, place them in the -# $(DOC_MODULE)-overrides.txt file and uncomment the second line here. -DOC_OVERRIDES = -#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS= +include $(top_srcdir)/doc/gtk-doc.make - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### - -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_OVERRIDES) - -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 - -if ENABLE_GTK_DOC -all-local: html-build.stamp - -#### scan #### - -scan-build.stamp: $(HFILE_GLOB) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - cd $(srcdir) && \ - gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) - touch scan-build.stamp - -$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp - @true - -#### templates #### - -tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_OVERRIDES) - @echo '*** Rebuilding template files ***' - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### xml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml - @echo '*** Building XML ***' - cd $(srcdir) && \ - gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --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 '*** Building HTML ***' - 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 '-- Fixing Crossreferences' - cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -endif - -############## - -clean-local: - rm -rf *~ *.bak $(SCANOBJ_FILES) .libs *-unused.txt $(DOC_STAMPS) - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -gtkdocdir=$(docdir) -gtkdochtmldir=$(gtkdocdir)/html -gtkdocpackagedir=$(gtkdochtmldir)/$(DOC_MODULE) - -gtkdocpackage_DATA = $(wildcard $(srcdir)/html/*.html) - -#install-data-local: -# $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) -# (installfiles=`echo $(srcdir)/html/*.html`; \ -# if test "$$installfiles" = '$(srcdir)/html/*.html'; \ -# then echo '-- Nothing to install' ; \ -# else \ -# 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) - -# -# 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)/sgml - mkdir $(distdir)/html - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/xml/*.xml $(distdir)/xml - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - - images=$(HTML_IMAGES) ; \ - for i in $$images ; do \ - cp $(srcdir)/$$i $(distdir)/html ; \ - done - -.PHONY : dist-hook-local +MAINTAINERCLEANFILES = Makefile.in tmpl/*.sgml hildon-fm-sections.txt \ + hildon-fm-overrides.txt hildon-fm-undocumented.txt Added: projects/haf/trunk/hildon-fm/doc/gtk-doc.make =================================================================== --- projects/haf/trunk/hildon-fm/doc/gtk-doc.make 2007-03-23 11:27:20 UTC (rev 10738) +++ projects/haf/trunk/hildon-fm/doc/gtk-doc.make 2007-03-23 11:36:15 UTC (rev 10739) @@ -0,0 +1,156 @@ +# -*- 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) + 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 + cd $(srcdir) && \ + gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) + touch scan-build.stamp + +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): 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 #### +tmpl_files := $(wildcard $(srcdir)/tmpl/*.sgml) + +sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(tmpl_files) $(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 Modified: projects/haf/trunk/hildon-fm/doc/hildon-fm-docs.xml =================================================================== --- projects/haf/trunk/hildon-fm/doc/hildon-fm-docs.xml 2007-03-23 11:27:20 UTC (rev 10738) +++ projects/haf/trunk/hildon-fm/doc/hildon-fm-docs.xml 2007-03-23 11:36:15 UTC (rev 10739) @@ -7,9 +7,23 @@ </bookinfo> <chapter> - <title>Hildon FM</title> - <xi:include href="xml/hildon-file-chooser-dialog.xml"/> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + + <chapter> + <title>Hildon FM</title> <xi:include href="xml/hildon-file-selection.xml"/> <xi:include href="xml/hildon-file-system-model.xml"/> + <xi:include href="xml/hildon-file-chooser-dialog.xml"/> + <xi:include href="xml/hildon-file-details-dialog.xml"/> + <xi:include href="xml/hildon-file-system-info.xml"/> </chapter> + + <index> + <title>Index</title> + </index> + <index role="deprecated"> + <title>Index of deprecated symbols</title> + </index> </book> Modified: projects/haf/trunk/hildon-fm/doc/hildon-fm.types =================================================================== --- projects/haf/trunk/hildon-fm/doc/hildon-fm.types 2007-03-23 11:27:20 UTC (rev 10738) +++ projects/haf/trunk/hildon-fm/doc/hildon-fm.types 2007-03-23 11:36:15 UTC (rev 10739) @@ -1,7 +1,9 @@ #include <hildon-file-selection.h> #include <hildon-file-chooser-dialog.h> #include <hildon-file-system-model.h> +#include <hildon-file-details-dialog.h> hildon_file_selection_get_type hildon_file_chooser_dialog_get_type hildon_file_system_model_get_type +hildon_file_details_dialog_get_type
- Previous message: [maemo-commits] r10738 - projects/haf/trunk/hildon-fm
- Next message: [maemo-commits] r10740 - projects/haf/trunk/hildon-desktop/debian
- Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]