docs/libs/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 MODULE=ges
   7 DOC_MODULE=$(MODULE)
   8
   9 # for upload-doc.mak
  10 DOC=gstreamer-editing-services
  11 FORMATS=html
  12 html: html-build.stamp
  13 include $(top_srcdir)/common/upload-doc.mak
  14
  15 # The top-level SGML file. Change it if you want.
  16 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  17
  18 # The directory containing the source code.
  19 # gtk-doc will search all .c & .h files beneath here for inline comments
  20 # documenting functions and macros.
  21 DOC_SOURCE_DIR = $(top_srcdir)/ges
  22
  23 SCAN_OPTIONS=
  24
  25 # Extra options to supply to gtkdoc-mkdb.
  26 MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc,m
  27
  28 # Extra options to supply to gtkdoc-fixref.
  29 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  30         --extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
  31         --extra-dir=$(GSTPB_PREFIX)/share/gtk-doc/html
  32
  33 # Used for dependencies.
  34 HFILE_GLOB=$(top_srcdir)/ges/ges-*.h
  35 CFILE_GLOB=$(top_srcdir)/ges/ges-*.c
  36
  37 # Extra options to supply to gtkdoc-scan.
  38 SCANOBJ_OPTIONS=--type-init-func="g_type_init();gst_init(&argc,&argv)"
  39
  40 # Header files to ignore when scanning.
  41 IGNORE_HFILES = \
  42         gesmarshal.h \
  43         ges-internal.h \
  44         ges-auto-transition.h \
  45         ges-structured-interface.h \
  46         ges-structure-parser.h \
  47         ges-smart-video-mixer.h \
  48         gstframepositioner.h
  49 IGNORE_CFILES =
  50
  51 # we add all .h files of elements that have signals/args we want
  52 # sadly this also pulls in the private methods - maybe we should
  53 # move those around in the source ?
  54 # also, we should add some stuff here conditionally based on whether
  55 # or not the plugin will actually build
  56 # but I'm not sure about that - it might be this Just Works given that
  57 # the registry won't have the element
  58
  59 EXTRA_HFILES = \
  60         $(top_srcdir)/ges/ges-types.h
  61
  62 # Images to copy into HTML directory.
  63 HTML_IMAGES =  layer_track_overview.png
  64
  65 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  66 content_files = architecture.xml
  67
  68 # Other files to distribute.
  69 extra_files =
  70
  71 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  72 # contains GtkObjects/GObjects and you want to document signals and properties.
  73 GTKDOC_CFLAGS = -I$(top_srcdir) $(GST_PBUTILS_CFLAGS) $(GST_BASE_CFLAGS) \
  74         $(GST_CFLAGS)  $(GIO_CFLAGS) $(GCOV_CFLAGS)
  75 GTKDOC_LIBS =  \
  76         $(top_builddir)/ges/libges-@GST_API_VERSION@.la \
  77         $(GST_BASE_LIBS) $(GST_LIBS) $(GIO_LIBS) $(GCOV_LIBS)
  78
  79 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
  80 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
  81
  82 # If you need to override some of the declarations, place them in this file
  83 # and uncomment this line.
  84 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
  85
  86 include $(top_srcdir)/common/gtk-doc.mak