Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
## Process this file with automake to produce Makefile.in
|
|
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# The name of the module, e.g. 'glib'.
|
2012-04-04 11:13:52 +00:00
|
|
|
# DOC_MODULE=gstreamer-@GST_API_VERSION@
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
DOC_MODULE=gstreamer
|
|
|
|
|
|
2009-01-27 17:53:01 +00:00
|
|
|
# don't want $(DOC_MODULE)-scan.c to be built with -Werror
|
|
|
|
|
ERROR_CFLAGS=
|
|
|
|
|
|
2005-11-30 19:36:54 +00:00
|
|
|
BUILT_SOURCES=gstreamer.types
|
|
|
|
|
|
2009-06-11 12:16:29 +00:00
|
|
|
# for upload-doc.mak
|
2004-01-28 12:16:51 +00:00
|
|
|
DOC=gstreamer
|
|
|
|
|
FORMATS=html
|
|
|
|
|
html: html-build.stamp
|
2009-06-11 12:16:29 +00:00
|
|
|
include $(top_srcdir)/common/upload-doc.mak
|
2004-01-28 12:16:51 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# The top-level SGML file. Change it if you want.
|
2001-01-01 14:06:25 +00:00
|
|
|
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
|
Re- set up the gtk-doc system. I'd managed to mutilate it a while back, but now it's fixed. I'll put a copy of the ...
Original commit message from CVS:
Re- set up the gtk-doc system. I'd managed to mutilate it a while back,
but now it's fixed. I'll put a copy of the HTML output somewhere on the
website tonight.
In order to actually generate the docs, you'll have to install all the
DocBook tools, as well as gtk-doc from GNOME cvs. (see
http://developer.gnome.org/arch/doc/tools.html)
Notes (I'll codify these some day):
- Don't believe the Gnome page, always edit the SOURCES when documenting a
given function, never the tmpl file.
- I'll be re-arranging things a lot, but gtk-doc is smart enough to merge
any changes to the tmpl file. However, gtk-doc's merge and CVS's diff are
two entirely separate animals. We should probably have a virtual mutex on
the entire docs/gst/ directory, over and above what CVS does.
- I'm going to try to end up with a book set (docbook terms), where
docs/gst/ is only one book. There'd be another called docs/manual/, and
another docs/plugins/, etc. If you have any comments as to how these
should be done, gstreamer-devel is the place.
2000-02-01 09:16:43 +00:00
|
|
|
|
2007-08-10 17:35:30 +00:00
|
|
|
# The files containing the source code. Relative to $(top_srcdir).
|
|
|
|
|
# gtk-doc will search all .c & .h files beneath here for inline comments
|
|
|
|
|
# documenting functions and macros.
|
|
|
|
|
DOC_SOURCE_DIR = $(top_srcdir)/gst
|
|
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# Extra options to supply to gtkdoc-scan.
|
2005-01-21 17:52:50 +00:00
|
|
|
SCAN_OPTIONS=--deprecated-guards="GST_DISABLE_DEPRECATED"
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-mkdb.
|
2007-08-10 17:35:30 +00:00
|
|
|
MKDB_OPTIONS=--sgml-mode --output-format=xml --ignore-files=parse
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-fixref.
|
2007-07-05 08:42:42 +00:00
|
|
|
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html
|
2001-12-12 06:08:44 +00:00
|
|
|
|
2007-08-10 17:35:30 +00:00
|
|
|
# Used for dependencies.
|
2011-09-07 12:05:03 +00:00
|
|
|
HFILE_GLOB=$(top_srcdir)/gst/*.h
|
|
|
|
|
CFILE_GLOB=$(top_srcdir)/gst/*.c
|
2001-12-12 06:08:44 +00:00
|
|
|
|
2004-04-08 14:45:13 +00:00
|
|
|
# Header files to ignore when scanning. Use base file name, no paths
|
2004-03-30 07:36:19 +00:00
|
|
|
IGNORE_HFILES= \
|
|
|
|
|
gettext.h \
|
2007-08-10 17:35:30 +00:00
|
|
|
glib-compat-private.h \
|
|
|
|
|
glib-compat.h \
|
2004-03-30 07:36:19 +00:00
|
|
|
gst-i18n-app.h \
|
2007-08-10 17:35:30 +00:00
|
|
|
gst-i18n-lib.h \
|
2004-03-30 07:36:19 +00:00
|
|
|
gst_private.h \
|
2010-03-02 21:58:06 +00:00
|
|
|
gstelementdetails.h \
|
2005-09-20 06:28:33 +00:00
|
|
|
gstmacros.h \
|
2007-08-10 17:35:30 +00:00
|
|
|
\
|
|
|
|
|
grammar.tab.h \
|
|
|
|
|
grammar.tab.pre.h \
|
2010-10-05 13:16:19 +00:00
|
|
|
math-compat.h \
|
2007-08-10 17:35:30 +00:00
|
|
|
types.h
|
2001-12-12 06:08:44 +00:00
|
|
|
|
2010-03-25 08:35:13 +00:00
|
|
|
gst-universe.svg: gst-universe.dot
|
|
|
|
|
-dot -Tsvg $< | sed 's/\(font-size:[0-9]*\.[0-9]*\);/\1px;/g' >$@
|
|
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# Images to copy into HTML directory.
|
|
|
|
|
HTML_IMAGES =
|
|
|
|
|
|
|
|
|
|
# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
|
2010-03-25 08:35:13 +00:00
|
|
|
content_files = building.xml running.xml gst-universe.svg
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# Other files to distribute.
|
2010-03-25 08:35:13 +00:00
|
|
|
extra_files = gst-universe.dot
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
|
|
|
|
|
# contains GtkObjects/GObjects and you want to document signals and properties.
|
2005-10-15 13:58:18 +00:00
|
|
|
GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS)
|
2012-08-06 12:33:57 +00:00
|
|
|
GTKDOC_LIBS = $(GST_OBJ_LIBS) \
|
|
|
|
|
$(top_builddir)/gst/libgstreamer-@GST_API_VERSION@.la \
|
|
|
|
|
$(top_builddir)/libs/gst/base/libgstbase-@GST_API_VERSION@.la \
|
|
|
|
|
$(top_builddir)/libs/gst/controller/libgstcontroller-@GST_API_VERSION@.la \
|
|
|
|
|
$(top_builddir)/libs/gst/net/libgstnet-@GST_API_VERSION@.la
|
|
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
|
2009-02-22 15:22:16 +00:00
|
|
|
GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
|
|
|
|
|
GTKDOC_LD=$(LIBTOOL) --tag=CC --mode=link $(CC)
|
2001-12-12 06:08:44 +00:00
|
|
|
|
2009-11-17 09:06:48 +00:00
|
|
|
GTKDOC_EXTRA_ENVIRONMENT= \
|
2013-01-15 13:47:32 +00:00
|
|
|
GST_PLUGIN_SCANNER_1_0=$(top_builddir)/libs/gst/helpers/gst-plugin-scanner
|
2009-11-17 09:06:48 +00:00
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# If you need to override some of the declarations, place them in this file
|
|
|
|
|
# and uncomment this line.
|
2011-09-07 14:07:20 +00:00
|
|
|
DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt
|
2000-05-12 07:15:03 +00:00
|
|
|
|
2005-07-07 14:16:40 +00:00
|
|
|
include $(top_srcdir)/common/gtk-doc.mak
|
2010-03-25 08:35:13 +00:00
|
|
|
|
|
|
|
|
# gtk-doc.mak defines CLEANFILES
|
|
|
|
|
CLEANFILES += gst-universe.svg
|
|
|
|
|
|
