1GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj 2 3## Process this file with automake to produce Makefile.in 4 5# The name of the module, e.g. 'glib'. 6#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@ 7MODULE=gst-plugins-base 8DOC_MODULE=$(MODULE)-plugins 9 10# for upload-doc.mak 11DOC=$(MODULE)-plugins 12FORMATS=html 13html: html-build.stamp 14include $(top_srcdir)/common/upload-doc.mak 15 16# The top-level SGML file. Change it if you want. 17DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml 18 19# The directory containing the source code. 20# gtk-doc will search all .c & .h files beneath here for inline comments 21# documenting functions and macros. 22DOC_SOURCE_DIR = $(top_srcdir)/gst $(top_srcdir)/ext $(top_srcdir)/sys 23 24# Extra options to supply to gtkdoc-scan. 25SCAN_OPTIONS= 26 27# Extra options to supply to gtkdoc-mkdb. 28MKDB_OPTIONS=--sgml-mode 29 30# Extra options to supply to gtkdoc-fixref. 31FIXXREF_OPTIONS=--extra-dir=$(top_builddir)/docs/libs/html \ 32 --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \ 33 --extra-dir=$(GST_PREFIX)/share/gtk-doc/html \ 34 --extra-dir=$(datadir)/gtk-doc/html 35 36# Used for dependencies. 37HFILE_GLOB=$(top_srcdir)/gst/*/*.h $(top_srcdir)/ext/*/*.h $(top_srcdir)/sys/*/*.h 38CFILE_GLOB=$(top_srcdir)/gst/*/*.c $(top_srcdir)/ext/*/*.c $(top_srcdir)/sys/*/*.c $(top_srcdir)/ext/*/*.m 39 40# Header files to ignore when scanning. 41IGNORE_HFILES = avcodec.h dsputil.h arch.h speex_resampler.h speex_resampler_wrapper.h fixed_arm4.h fixed_arm5e.h fixed_bfin.h fixed_debug.h fixed_generic.h resample_sse.h 42IGNORE_CFILES = utils.c mem.c imgconvert.c 43 44# we add all .h files of elements that have signals/args we want 45# sadly this also pulls in the private methods - maybe we should 46# move those around in the source ? 47# also, we should add some stuff here conditionally based on whether 48# or not the plugin will actually build 49# but I'm not sure about that - it might be this Just Works given that 50# the registry won't have the element 51 52EXTRA_HFILES = \ 53 $(top_srcdir)/ext/alsa/gstalsasink.h \ 54 $(top_srcdir)/ext/alsa/gstalsasrc.h \ 55 $(top_srcdir)/ext/cdparanoia/gstcdparanoiasrc.h \ 56 $(top_srcdir)/ext/ogg/gstoggdemux.h \ 57 $(top_srcdir)/ext/ogg/gstoggmux.h \ 58 $(top_srcdir)/ext/opus/gstopusdec.h \ 59 $(top_srcdir)/ext/opus/gstopusenc.h \ 60 $(top_srcdir)/ext/pango/gstclockoverlay.h \ 61 $(top_srcdir)/ext/pango/gsttextoverlay.h \ 62 $(top_srcdir)/ext/pango/gsttextrender.h \ 63 $(top_srcdir)/ext/pango/gsttimeoverlay.h \ 64 $(top_srcdir)/ext/theora/gsttheoradec.h \ 65 $(top_srcdir)/ext/theora/gsttheoraenc.h \ 66 $(top_srcdir)/ext/theora/gsttheoraparse.h \ 67 $(top_srcdir)/ext/vorbis/gstvorbisdec.h \ 68 $(top_srcdir)/ext/vorbis/gstvorbisenc.h \ 69 $(top_srcdir)/ext/vorbis/gstvorbisparse.h \ 70 $(top_srcdir)/ext/vorbis/gstvorbistag.h \ 71 $(top_srcdir)/gst/adder/gstadder.h \ 72 $(top_srcdir)/gst/audioconvert/gstaudioconvert.h \ 73 $(top_srcdir)/gst/audiorate/gstaudiorate.h \ 74 $(top_srcdir)/gst/audioresample/gstaudioresample.h \ 75 $(top_srcdir)/gst/audiotestsrc/gstaudiotestsrc.h \ 76 $(top_srcdir)/gst/encoding/gstencodebin.h \ 77 $(top_srcdir)/gst/gio/gstgiosink.h \ 78 $(top_srcdir)/gst/gio/gstgiosrc.h \ 79 $(top_srcdir)/gst/gio/gstgiostreamsink.h \ 80 $(top_srcdir)/gst/gio/gstgiostreamsrc.h \ 81 $(top_srcdir)/gst/playback/gstplay-enum.h \ 82 $(top_srcdir)/gst/playback/gstplaysink.h \ 83 $(top_srcdir)/gst/playback/gststreamsynchronizer.h \ 84 $(top_srcdir)/gst/playback/gstsubtitleoverlay.h \ 85 $(top_srcdir)/gst/audiorate/gstaudiorate.h \ 86 $(top_srcdir)/gst/audioresample/gstaudioresample.h \ 87 $(top_srcdir)/gst/overlaycomposition/gstoverlaycomposition.h \ 88 $(top_srcdir)/gst/rawparse/gstrawaudioparse.h \ 89 $(top_srcdir)/gst/rawparse/gstrawvideoparse.h \ 90 $(top_srcdir)/gst/rawparse/gstunalignedaudioparse.h \ 91 $(top_srcdir)/gst/rawparse/gstunalignedvideoparse.h \ 92 $(top_srcdir)/gst/subparse/gstssaparse.h \ 93 $(top_srcdir)/gst/subparse/gstsubparse.h \ 94 $(top_srcdir)/gst/tcp/gstmultifdsink.h \ 95 $(top_srcdir)/gst/tcp/gstmultihandlesink.h \ 96 $(top_srcdir)/gst/tcp/gstmultisocketsink.h \ 97 $(top_srcdir)/gst/tcp/gstsocketsrc.h \ 98 $(top_srcdir)/gst/tcp/gsttcpclientsink.h \ 99 $(top_srcdir)/gst/tcp/gsttcpclientsrc.h \ 100 $(top_srcdir)/gst/tcp/gsttcp.h \ 101 $(top_srcdir)/gst/tcp/gsttcpserversink.h \ 102 $(top_srcdir)/gst/tcp/gsttcpserversrc.h \ 103 $(top_srcdir)/gst/videoconvert/gstvideoconvert.h \ 104 $(top_srcdir)/gst/videorate/gstvideorate.h \ 105 $(top_srcdir)/gst/videoscale/gstvideoscale.h \ 106 $(top_srcdir)/gst/videotestsrc/gstvideotestsrc.h \ 107 $(top_srcdir)/gst/volume/gstvolume.h \ 108 $(top_srcdir)/sys/ximage/ximagesink.h \ 109 $(top_srcdir)/sys/xvimage/xvimagesink.h \ 110 $(top_srcdir)/gst-libs/gst/app/gstappsrc.h \ 111 $(top_srcdir)/gst-libs/gst/app/gstappsink.h 112 113# Images to copy into HTML directory. 114HTML_IMAGES = 115 116# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). 117content_files = 118 119# Other files to distribute. 120extra_files = 121 122# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib 123# contains GtkObjects/GObjects and you want to document signals and properties. 124GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs 125GTKDOC_LIBS = $(GST_BASE_LIBS) 126 127# If you need to override some of the declarations, place them in this file 128DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt 129 130include $(top_srcdir)/common/gtk-doc-plugins.mak 131