# $Id$ # automake include file for gtk-doc, define your '#%' lines # from gtk-doc-0.9-5/usr/share/doc/gtk-doc-0.9/examples/Makefile.am # Copyright (C) 2002 Jan Kratochvil # # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; exactly version 2 of June 1991 is required # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # local diff: # s/EXTRA_DIST =/EXTRA_DIST +=/ # s/tmpl-build.stamp:/tmpl-build.stamp $(srcdir)/tmpl/*.sgml:/ # Prevent: No rule to make target `tmpl/*.sgml', needed by `sgml-build.stamp'. Stop. # Fixes gtk-doc-0.9/setting-up.txt/: # (Note that due to make being awkward the build # may fail the first time, but if you run make again it should work.) # s/gtkdoc-scanobj/gtkdoc-scangobj/ # Note that if your project is targeted at GTK+ 2.0 rather # than GTK+ 1.2.x, then you will have to change it so it # runs gtkdoc-scangobj rather than gtkdoc-scanobj. # s/: scan-build.stamp/ $(DOC_MODULE)-sections.txt &/ # Prevent: No rule to make target `$(DOC_MODULE)-sections.txt', needed by `distdir'. Stop. # s/gtkdoc-scan --module=/rm -f $(SCANOBJ_FILES) \&\& &/ # Do not forget to rebuild some files. # Create sgml/sgml/ to satisfy sgml/-based includes from sgml/MODULE-doc.top # Prevent: sgml.stamp defined both conditionally and unconditionally if ENABLE_GTK_DOC sgml.stamp: sgml/sgml sgml/sgml: @$(LN_S) ./ $@ endif #% ## Process this file with automake to produce Makefile.in #% #% # 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= #% #% # The top-level SGML file. Change it if you want. #% 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 functions and macros. #% DOC_SOURCE_DIR= #% #% # Extra options to pass to gtkdoc-scangobj or gtkdoc-scangobj. #% SCANOBJ_OPTIONS= #% #% # Extra options to supply to gtkdoc-scan. #% SCAN_OPTIONS= #% #% # Extra options to supply to gtkdoc-mkdb. #% MKDB_OPTIONS= #% #% # Extra options to supply to gtkdoc-fixref. #% FIXXREF_OPTIONS= #% #% # Used for dependencies. #% HFILE_GLOB= #% CFILE_GLOB= #% #% # Header files to ignore when scanning. #% IGNORE_HFILES= #% #% # 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 = #% GTKDOC_LIBS = #% #% 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_MODULE)-sections.txt \ $(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).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) && \ rm -f $(SCANOBJ_FILES) && 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) $(DOC_MODULE)-sections.txt : scan-build.stamp @true #### templates #### tmpl-build.stamp $(srcdir)/tmpl/*.sgml: $(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 #### sgml #### 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) --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 ***' test -d $(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 -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) maintainer-clean-local: clean cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt 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)/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 .PHONY : dist-hook-local