docs/plugins/Makefile.am

   1 GST_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_MAJORMINOR@
   7 MODULE=gst-plugins-bad
   8 DOC_MODULE=$(MODULE)-plugins
   9
  10 # for upload.mak
  11 DOC=$(MODULE)-plugins
  12 FORMATS=html
  13 html: html-build.stamp
  14 include $(top_srcdir)/common/upload-doc.mak
  15
  16 # generated basefiles
  17 #basefiles = \
  18 ##              $(DOC_MODULE).types \
  19 #               $(DOC_MODULE)-sections.txt \
  20 #               $(DOC_MODULE)-docs.sgml
  21
  22 # ugly hack to make -unused.sgml work
  23 #unused-build.stamp:
  24 #       BUILDDIR=`pwd` && \
  25 #       cd $(srcdir)/tmpl && \
  26 #       ln -sf gstreamer-libs-unused.sgml \
  27 #               $$BUILDDIR/tmpl/gstreamer-libs-@GST_MAJORMINOR@-unused.sgml
  28 #       touch unused-build.stamp
  29
  30 # these rules are added to create parallel docs using GST_MAJORMINOR
  31 #$(basefiles): gstreamer-libs-@GST_MAJORMINOR@%: gstreamer-libs%
  32 #       cp $< $@
  33
  34 #CLEANFILES = $(basefiles)
  35
  36 # The top-level SGML file. Change it if you want.
  37 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  38
  39 # The directory containing the source code. Relative to $(top_srcdir).
  40 # gtk-doc will search all .c & .h files beneath here for inline comments
  41 # documenting functions and macros.
  42 DOC_SOURCE_DIR = $(top_srcdir)
  43
  44 # Extra options to supply to gtkdoc-scan.
  45 SCAN_OPTIONS=
  46
  47 # FIXME :
  48 # there's something wrong with gstreamer-sections.txt not being in the dist
  49 # maybe it doesn't resolve; we're adding it below for now
  50 #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
  51
  52 # Extra options to supply to gtkdoc-mkdb.
  53 MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc,m
  54
  55 # Extra options to supply to gtkdoc-fixref.
  56 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  57         --extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
  58         --extra-dir=$(GSTPB_PREFIX)/share/gtk-doc/html
  59
  60 # Used for dependencies.
  61 HFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.h $(DOC_SOURCE_DIR)/*/*/*.hh
  62 CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*/*.c $(DOC_SOURCE_DIR)/*/*/*.cc
  63
  64 # this is a wingo addition
  65 # thomasvs: another nice wingo addition would be an explanation on why
  66 # this is useful ;)
  67
  68 SCANOBJ_DEPS =
  69
  70 # Header files to ignore when scanning.
  71 IGNORE_HFILES =
  72 IGNORE_CFILES =
  73
  74 # we add all .h files of elements that have signals/args we want
  75 # sadly this also pulls in the private methods - maybe we should
  76 # move those around in the source ?
  77 #
  78 # also, we should add some stuff here conditionally based on whether
  79 # or not the plugin will actually build
  80 # but I'm not sure about that - it might be this Just Works given that
  81 # the registry won't have the element
  82 # -> it just works (TM) (ensonic)
  83
  84 # FIXME: not ported yet
  85 #       $(top_srcdir)/ext/gnomevfs/gstgnomevfssink.c
  86
  87 # example code that needs to be converted to xml and placed in xml/
  88 EXAMPLE_CFILES = \
  89         $(top_srcdir)/ext/directfb/dfb-example.c
  90
  91 EXTRA_HFILES = \
  92         $(top_srcdir)/ext/amrwb/gstamrwbdec.h \
  93         $(top_srcdir)/ext/amrwb/gstamrwbenc.h \
  94         $(top_srcdir)/ext/amrwb/gstamrwbparse.h \
  95         $(top_srcdir)/ext/celt/gstceltdec.h \
  96         $(top_srcdir)/ext/celt/gstceltenc.h \
  97         $(top_srcdir)/ext/dc1394/gstdc1394.h \
  98         $(top_srcdir)/ext/directfb/dfbvideosink.h \
  99         $(top_srcdir)/ext/ivorbis/vorbisdec.h \
 100         $(top_srcdir)/ext/jack/gstjackaudiosrc.h \
 101         $(top_srcdir)/ext/jack/gstjackaudiosink.h \
 102         $(top_srcdir)/ext/musicbrainz/gsttrm.h \
 103         $(top_srcdir)/ext/metadata/gstbasemetadata.h \
 104         $(top_srcdir)/ext/metadata/gstmetadatademux.h \
 105         $(top_srcdir)/ext/metadata/gstmetadatamux.h \
 106         $(top_srcdir)/ext/modplug/gstmodplug.h \
 107         $(top_srcdir)/ext/mpeg2enc/gstmpeg2enc.hh \
 108         $(top_srcdir)/ext/mplex/gstmplex.hh \
 109         $(top_srcdir)/ext/mythtv/gstmythtvsrc.h \
 110         $(top_srcdir)/ext/sdl/sdlaudiosink.h \
 111         $(top_srcdir)/ext/sdl/sdlvideosink.h \
 112         $(top_srcdir)/ext/theora/theoradec.h \
 113         $(top_srcdir)/ext/timidity/gsttimidity.h \
 114         $(top_srcdir)/ext/timidity/gstwildmidi.h \
 115         $(top_srcdir)/ext/twolame/gsttwolame.h \
 116         $(top_srcdir)/ext/x264/gstx264enc.h \
 117         $(top_srcdir)/gst/aacparse/gstaacparse.h \
 118         $(top_srcdir)/gst/amrparse/gstamrparse.h \
 119         $(top_srcdir)/gst/legacyresample/gstlegacyresample.h \
 120         $(top_srcdir)/gst/deinterlace/gstdeinterlace.h \
 121         $(top_srcdir)/gst/dccp/gstdccpclientsink.h \
 122         $(top_srcdir)/gst/dccp/gstdccpclientsrc.h \
 123         $(top_srcdir)/gst/dccp/gstdccpserversink.h \
 124         $(top_srcdir)/gst/dccp/gstdccpserversrc.h \
 125         $(top_srcdir)/gst/dvdspu/gstdvdspu.h \
 126         $(top_srcdir)/gst/festival/gstfestival.h \
 127         $(top_srcdir)/gst/mxf/mxfdemux.h \
 128         $(top_srcdir)/gst/nuvdemux/gstnuvdemux.h \
 129         $(top_srcdir)/gst/rawparse/gstaudioparse.h \
 130         $(top_srcdir)/gst/rawparse/gstvideoparse.h \
 131         $(top_srcdir)/gst/rtpmanager/gstrtpbin.h \
 132         $(top_srcdir)/gst/rtpmanager/gstrtpclient.h \
 133         $(top_srcdir)/gst/rtpmanager/gstrtpjitterbuffer.h \
 134         $(top_srcdir)/gst/rtpmanager/gstrtpptdemux.h \
 135         $(top_srcdir)/gst/rtpmanager/gstrtpsession.h \
 136         $(top_srcdir)/gst/rtpmanager/gstrtpssrcdemux.h \
 137         $(top_srcdir)/gst/scaletempo/gstscaletempo.h \
 138         $(top_srcdir)/gst/sdp/gstsdpdemux.h \
 139         $(top_srcdir)/gst/selector/gstinputselector.h \
 140         $(top_srcdir)/gst/selector/gstoutputselector.h \
 141         $(top_srcdir)/gst/speed/gstspeed.h \
 142         $(top_srcdir)/gst/stereo/gststereo.h \
 143         $(top_srcdir)/gst/videosignal/gstvideoanalyse.h \
 144         $(top_srcdir)/gst/videosignal/gstvideodetect.h \
 145         $(top_srcdir)/gst/videosignal/gstvideomark.h \
 146         $(top_srcdir)/gst/y4m/gsty4mencode.h \
 147         $(top_srcdir)/gst/liveadder/liveadder.h \
 148         $(top_srcdir)/sys/dvb/gstdvbsrc.h
 149
 150 # Images to copy into HTML directory.
 151 HTML_IMAGES =
 152
 153 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
 154 content_files =
 155
 156 # Other files to distribute.
 157 extra_files =
 158
 159 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
 160 # contains GtkObjects/GObjects and you want to document signals and properties.
 161 GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir)
 162 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_BASE_LIBS)
 163
 164 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
 165 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
 166
 167 # If you need to override some of the declarations, place them in this file
 168 # and uncomment this line.
 169 #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
 170 DOC_OVERRIDES =
 171
 172 include $(top_srcdir)/common/gtk-doc-plugins.mak