Moving the sgml documentation to code.
[hildon] / doc / Makefile.am
index fc845c3..96d1fd8 100644 (file)
-## Process this file with automake to produce Makefile.in
+MAINTAINERCLEANFILES                           = Makefile.in                           \
+                                                 hildon-sections.txt                   \
+                                                 hildon-undocumented.txt               \
+                                                 version.xml
 
-# 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.
+DOC_MODULE                                     = hildon
 
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=hildon-libs
+DOC_MAIN_SGML_FILE                             = $(DOC_MODULE)-docs.sgml
 
-# The top-level SGML file. Change it if you want.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
+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=../hildon-widgets
+SCANOBJ_OPTIONS                                        =--type-init-func="gtk_type_init(0)"
 
-# Extra options to pass to gtkdoc-scanobj or gtkdoc-scangobj.
-SCANOBJ_OPTIONS=--type-init-func="gtk_type_init(0)"
+DOC_SOURCE_DIR                                 =../src
 
-# Extra options to supply to gtkdoc-scan.
-SCAN_OPTIONS=
+HFILE_GLOB                                     =$(top_srcdir)/src/*.h
 
-# Header files to ignore when scanning.
-IGNORE_HFILES=*private* config.h ut md5.h hildon-volumebar-range.h hildon-volumebar-private.h \
-               hildon-app-private.h
+CFILE_GLOB                                     =$(top_srcdir)/src/*.c
 
-# Files to ignore when making the DB.
-IGNORE_FILES=$(IGNORE_HFILES)
+IGNORE_HFILES                                  = hildon-banner-private.h               \
+                                                 hildon-calendar-popup-private.h       \
+                                                 hildon-caption-private.h              \
+                                                 hildon-code-dialog-private.h          \
+                                                 hildon-color-button-private.h         \
+                                                 hildon-color-chooser-dialog-private.h \
+                                                 hildon-color-chooser-private.h        \
+                                                 hildon-controlbar-private.h           \
+                                                 hildon-date-editor-private.h          \
+                                                 hildon-find-toolbar-private.h         \
+                                                 hildon-font-selection-dialog-private.h\
+                                                 hildon-get-password-dialog-private.h  \
+                                                 hildon-login-dialog-private.h         \
+                                                 hildon-note-private.h                 \
+                                                 hildon-number-editor-private.h        \
+                                                 hildon-private.c                      \
+                                                 hildon-private.h                      \
+                                                 hildon-program-private.h              \
+                                                 hildon-range-editor-private.h         \
+                                                 hildon-seekbar-private.h              \
+                                                 hildon-set-password-dialog-private.h  \
+                                                 hildon-sort-dialog-private.h          \
+                                                 hildon-time-editor-private.h          \
+                                                 hildon-time-picker-private.h          \
+                                                 hildon-volumebar-private.h            \
+                                                 hildon-weekday-picker-private.h       \
+                                                 hildon-window-private.h               \
+                                                 hildon-wizard-dialog-private.h
 
-# Extra options to supply to gtkdoc-mkdb.
-MKDB_OPTIONS=--ignore-files="$(IGNORE_FILES)" --sgml-mode --output-format=xml
+INCLUDES                                       = $(GTK_CFLAGS) -I$(top_srcdir)
 
-# Extra options to supply to gtkdoc-fixref.
-FIXXREF_OPTIONS=
+GTKDOC_LIBS                                    = $(GTK_LIBS) ../src/libhildon_@PACKAGE_VERSION_MAJOR@.la 
 
-# Used for dependencies.
-HFILE_GLOB=$(top_srcdir)/hildon-widgets/*.h
-CFILE_GLOB=$(top_srcdir)/hildon-widgets/*.c
+MKDB_OPTIONS                                   =--sgml-mode
 
+content_files                                  = version.xml
 
+version.xml: ../configure.ac
+       @echo $(VERSION) > version.xml
 
-# Images to copy into HTML directory.
-HTML_IMAGES =
+html: html-build.stamp
 
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-content_files =
+HTML_IMAGES                                    =
 
-# Other files to distribute.
-extra_files =
+FIXXREF_OPTIONS                                        =
 
-# 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) $(GNOME_VFS_CFLAGS)
-GTKDOC_LIBS = $(GTK_LIBS) ../hildon-widgets/libhildonwidgets.la 
+include $(top_srcdir)/gtk-doc.make
 
-GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
-GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
-
-# 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
-
-
-
-###########################################################################
-# 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