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=gst-rtsp-server
   7 DOC_MODULE=$(MODULE)
   8
   9 # for upload-doc.mak
  10 DOC=$(MODULE)
  11 FORMATS=html
  12 html: html-build.stamp
  13 include $(top_srcdir)/common/upload-doc.mak
  14
  15 # generated basefiles
  16 #basefiles = \
  17 ##              $(DOC_MODULE).types \
  18 #               $(DOC_MODULE)-sections.txt \
  19 #               $(DOC_MODULE)-docs.sgml
  20
  21 # ugly hack to make -unused.sgml work
  22 #unused-build.stamp:
  23 #       BUILDDIR=`pwd` && \
  24 #       cd $(srcdir)/tmpl && \
  25 #       ln -sf gstreamer-libs-unused.sgml \
  26 #               $$BUILDDIR/tmpl/gstreamer-libs-@GST_API_VERSION@-unused.sgml
  27 #       touch unused-build.stamp
  28
  29 # these rules are added to create parallel docs using GST_API_VERSION
  30 #$(basefiles): gstreamer-libs-@GST_API_VERSION@%: gstreamer-libs%
  31 #       cp $< $@
  32
  33 #CLEANFILES = $(basefiles)
  34
  35 # The top-level SGML file. Change it if you want.
  36 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
  37
  38 # The directory containing the source code. Relative to $(top_srcdir).
  39 # gtk-doc will search all .c & .h files beneath here for inline comments
  40 # documenting functions and macros.
  41 DOC_SOURCE_DIR = $(top_srcdir)/gst/rtsp-server/
  42 DOC_BUILD_DIR=$(top_builddir)/gst/rtsp-server/
  43
  44 SCAN_OPTIONS=
  45
  46 # FIXME :
  47 # there's something wrong with gstreamer-sections.txt not being in the dist
  48 # maybe it doesn't resolve; we're adding it below for now
  49 #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
  50
  51 # Extra options to supply to gtkdoc-mkdb.
  52 MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc,m
  53
  54 # Extra options to supply to gtkdoc-fixref.
  55 FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
  56         --extra-dir=$(GST_PREFIX)/share/gtk-doc/html \
  57         --extra-dir=$(GSTPB_PREFIX)/share/gtk-doc/html
  58
  59 # Used for dependencies.
  60 HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
  61 CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
  62
  63 SCANOBJ_DEPS = \
  64         $(top_builddir)/gst/rtsp-server/libgstrtspserver-@GST_API_VERSION@.la
  65
  66 # Extra options to supply to gtkdoc-scan.
  67 SCANOBJ_OPTIONS=--type-init-func="g_type_init();gst_init(&argc,&argv)"
  68
  69 # Header files to ignore when scanning.
  70 IGNORE_HFILES =
  71 IGNORE_CFILES =
  72
  73 # we add all .h files of elements that have signals/args we want
  74 # sadly this also pulls in the private methods - maybe we should
  75 # move those around in the source ?
  76 # also, we should add some stuff here conditionally based on whether
  77 # or not the plugin will actually build
  78 # but I'm not sure about that - it might be this Just Works given that
  79 # the registry won't have the element
  80
  81 EXTRA_HFILES =
  82
  83 # Images to copy into HTML directory.
  84 HTML_IMAGES =
  85
  86 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  87 content_files =
  88
  89 # Other files to distribute.
  90 extra_files =
  91
  92 # CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
  93 # contains GtkObjects/GObjects and you want to document signals and properties.
  94 GTKDOC_CFLAGS = -I$(top_srcdir) $(GST_PLUGINS_BASE_CFLAGS) \
  95         $(GST_BASE_CFLAGS) $(GST_CFLAGS)
  96 GTKDOC_LIBS = $(SCANOBJ_DEPS) $(GST_PLUGINS_BASE_LIBS) \
  97         $(GST_BASE_LIBS) $(GST_LIBS) $(GCOV_LIBS)
  98
  99 GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
 100 GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
 101
 102 # If you need to override some of the declarations, place them in this file
 103 # and uncomment this line.
 104 DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
 105
 106 include $(top_srcdir)/common/gtk-doc.mak