1# Makefile.am - template makefile for gtk-doc module 2# Copyright (C) 2007-2017 Stefan Sauer 3# 4# This program is free software: you can redistribute it and/or modify 5# it under the terms of the GNU General Public License as published by 6# the Free Software Foundation, either version 3 of the License, or 7# (at your option) any later version. 8# 9# This program is distributed in the hope that it will be useful, 10# but WITHOUT ANY WARRANTY; without even the implied warranty of 11# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12# GNU General Public License for more details. 13# 14# You should have received a copy of the GNU General Public License 15# along with this program. If not, see <http://www.gnu.org/licenses/>. 16# 17# As a special exception, the above copyright owner gives unlimited 18# permission to copy, distribute and modify this Makefile.am template. 19# You need not follow the terms of the GNU General Public License when 20# using or distributing such Makefile.am files, even though portions of 21# the text of the Makefile.am appear in them. The GNU General Public 22# License (GPL) does govern all other use of the material that constitutes 23# the Makefile.am template. 24 25# This is a blank Makefile.am for using gtk-doc. 26# Copy this to your project's API docs directory and modify the variables to 27# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples 28# of using the various options. 29 30# The name of the module, e.g. 'glib'. 31DOC_MODULE=libags_audio 32 33# Uncomment for versioned docs and specify the version of the module, e.g. '2'. 34#DOC_MODULE_VERSION=2 35 36# The top-level XML file. 37DOC_MAIN_SGML_FILE=$(DOC_MODULE).xml 38 39# Directories containing the source code. 40# gtk-doc will search all .c and .h files beneath these paths 41# for inline comments documenting functions and macros. 42# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk 43DOC_SOURCE_DIR=$(top_srcdir)/ags/plugin $(top_srcdir)/ags/audio 44 45# Extra options to pass to gtkdoc-scangobj. Normally not needed. 46SCANGOBJ_OPTIONS=--cflags="$(CFLAGS) $(UUID_CFLAGS) $(LIBXML2_CFLAGS) $(XMLRPC_CFLAGS) $(XMLRPC_UTIL_CFLAGS) $(XMLRPC_SERVER_ABYSS_CFLAGS) $(XMLRPC_SERVER_CGI_CFLAGS) $(XMLRPC_SERVER_CFLAGS) $(OPENSSL_CFLAGS) $(GOBJECT_CFLAGS) $(LIBASOUND2_CFLAGS) $(LIBAO_CFLAGS) $(SNDFILE_CFLAGS) $(LIBINSTPATCH_CFLAGS) $(JACK_CFLAGS)" --ldflags="-static -ldl -lm -lrt -pthread $(LDFLAGS) $(UUID_LIBS) $(LIBASOUND2_LIBS) $(LIBAO_LIBS) $(LIBXML2_LIBS) $(OPENSSL_LIBS) $(XMLRPC_LIBS) $(XMLRPC_UTIL_LIBS) $(XMLRPC_SERVER_ABYSS_LIBS) $(XMLRPC_SERVER_CGI_LIBS) $(XMLRPC_SERVER_LIBS) $(GOBJECT_LIBS) $(SNDFILE_LIBS) $(LIBINSTPATCH_LIBS) $(JACK_LIBS) -L$(top_builddir) $(top_builddir)/libags.la $(top_builddir)/libags_thread.la $(top_builddir)/libags_server.la $(top_builddir)/libags_audio.la" 47 48# Extra options to supply to gtkdoc-scan. 49# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" 50# SCAN_OPTIONS=--rebuild-types --rebuild-sections 51SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" 52 53# Extra options to supply to gtkdoc-mkdb 54# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml 55MKDB_OPTIONS=--xml-mode --output-format=xml --name-space=ags --module=libags_audio 56 57# Extra options to supply to gtkdoc-mkhtml 58MKHTML_OPTIONS= 59 60# Extra options to supply to gtkdoc-fixref. Normally not needed. 61# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html 62FIXXREF_OPTIONS=--module=libags_audio --module-dir=./libags-audio-html/ --html-dir=$(DESTDIR)/$(datadir)/doc/libags-audio-doc/api --extra-dir=$(top_srcdir)/docs/reference/libags/libags-html 63 64# Used for dependencies. The docs will be rebuilt if any of these change. 65# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h 66# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c 67HFILE_GLOB= 68CFILE_GLOB= 69 70# Extra header to include when scanning, which are not under DOC_SOURCE_DIR 71# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h 72EXTRA_HFILES= 73 74# Header files or dirs to ignore when scanning. Use base file/dir names 75# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code 76IGNORE_HFILES=ags_lv2_state_manager.h 77 78# Images to copy into HTML directory. 79# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png 80HTML_IMAGES= 81 82# Extra files that are included by $(DOC_MAIN_SGML_FILE). 83# e.g. content_files=running.xml building.xml changes-2.0.xml 84content_files= 85 86# Files where gtk-doc abbrevations (#GtkWidget) are expanded 87# e.g. expand_content_files=running.xml 88expand_content_files= 89 90AM_CPPFLAGS = \ 91 -I$(top_srcdir) \ 92 -I$(top_builddir) 93 94# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. 95# Only needed if you are using gtkdoc-scangobj to dynamically query widget 96# signals and properties. 97# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) 98# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) 99GTKDOC_CFLAGS=$(gsequencer_CFLAGS) -DGTK_IS_WIDGET_CLASS=1 100GTKDOC_LIBS = \ 101 $(top_builddir)/libags.la \ 102 $(top_builddir)/libags_thread.la \ 103 $(top_builddir)/libags_server.la \ 104 $(top_builddir)/libags_audio.la 105 106# This includes the standard gtk-doc make rules, copied by gtkdocize. 107include ./gtk-doc.make 108 109# Comment this out if you want 'make check' to test you doc status 110# and run some sanity checks 111if ENABLE_GTK_DOC 112TESTS_ENVIRONMENT = \ 113 DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \ 114 SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir) 115TESTS = $(GTKDOC_CHECK) 116endif 117 118-include $(top_srcdir)/git.mk 119
