These changes improve the quality of the documentation by adding
[platform/upstream/atk.git] / docs / Makefile.am
index d993720..b85551b 100644 (file)
@@ -15,7 +15,8 @@ INSTALLDIR=$(prefix)/share/gtk-doc
 
 HTML_DIR = ${datadir}/gtk-doc/html
 
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
+# Header files to ignore when scanning
+IGNORE_HFILES =        atkmarshal.h
 
 # Images to copy into HTML directory
 HTML_IMAGES =
@@ -26,6 +27,23 @@ content_files =
 # Other files to distribute
 extra_files =
 
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+GTKDOC_CFLAGS = @STRIP_BEGIN@                          \
+       @CFLAGS@                                        \
+       -I$(top_srcdir)                                 \
+       -I$(top_builddir)                               \
+       @DEP_CFLAGS@                                    \
+@STRIP_END@
+
+GTKDOC_LIBS = @STRIP_BEGIN@                                            \
+       $(top_builddir)/atk/@atktargetlib@                              \
+@STRIP_END@
+
+GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
+GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
+
+
 dist-hook-local: all-local
 
 ####################################
@@ -41,18 +59,20 @@ GPATH = $(srcdir)
 
 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
 
-EXTRA_DIST =                           \
+EXTRA_DIST =                           \
        $(content_files)                \
        $(extra_files)                  \
        $(HTML_IMAGES)                  \
        $(DOC_MAIN_SGML_FILE)           \
+       $(DOC_MODULE).types             \
        $(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
+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      \
+SCANOBJ_FILES =                \
+       $(DOC_MODULE).args      \
        $(DOC_MODULE).hierarchy \
        $(DOC_MODULE).signals
 
@@ -65,12 +85,12 @@ 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 --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
-               else \
-       cd $(srcdir) ; \
-       for i in $(SCANOBJ_FILES) ; do \
-               test -f $$i || touch $$i ; \
-       done \
-        fi
+       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
@@ -93,7 +113,7 @@ tmpl.stamp: tmpl-build.stamp
 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
        @echo '*** Building SGML ***'
        cd $(srcdir) && \
-        gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
+       gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
        touch sgml-build.stamp
 
 sgml.stamp: sgml-build.stamp
@@ -103,10 +123,11 @@ sgml.stamp: sgml-build.stamp
 
 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
        @echo '*** Building HTML ***'
-       test -d $(srcdir)/html || mkdir $(srcdir)/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'
+       @echo '-- Fixing Crossreferences' 
        cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
        touch html-build.stamp
 endif
@@ -121,13 +142,13 @@ maintainer-clean-local: clean
 
 install-data-local:
        $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
-       (installfiles=`echo $(srcdir)/html/*.html`; \
-       if test "$$installfiles" = '$(srcdir)/html/*.html'; \
+       (installfiles=`echo $(srcdir)/html/*`; \
+       if test "$$installfiles" = '$(srcdir)/html/*'; \
        then echo '-- Nothing to install' ; \
        else \
          for i in $$installfiles; do \
-       echo '-- Installing '$$i ; \
-       $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
+           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); \
@@ -150,12 +171,6 @@ dist-hook: dist-check-gtkdoc dist-hook-local
        mkdir $(distdir)/html
        -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
        -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-       cp $(srcdir)/html/index.sgml $(distdir)/html
-       -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
-
-       images=$(HTML_IMAGES) ;                 \
-       for i in $$images ; do                  \
-         cp $(srcdir)/$$i $(distdir)/html ;  \
-       done
+       -cp $(srcdir)/html/* $(distdir)/html
 
-.PHONY : html sgml templates scan dist-hook-local
+.PHONY : dist-hook-local