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'.
|
2003-05-18 15:04:26 +00:00
|
|
|
# DOC_MODULE=gstreamer-@GST_MAJORMINOR@
|
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
|
|
|
|
|
|
2004-01-28 12:16:51 +00:00
|
|
|
# for upload.mak
|
|
|
|
|
DOC=gstreamer
|
|
|
|
|
FORMATS=html
|
|
|
|
|
html: html-build.stamp
|
2004-04-19 22:54:58 +00:00
|
|
|
include $(srcdir)/../upload.mak
|
2004-01-28 12:16:51 +00:00
|
|
|
|
2003-05-18 15:04:26 +00:00
|
|
|
# generated basefiles
|
|
|
|
|
#basefiles = \
|
|
|
|
|
# gstreamer-@GST_MAJORMINOR@.types \
|
|
|
|
|
# gstreamer-@GST_MAJORMINOR@-sections.txt \
|
|
|
|
|
# gstreamer-@GST_MAJORMINOR@-docs.sgml
|
|
|
|
|
|
|
|
|
|
# ugly hack to make -unused.sgml work
|
|
|
|
|
#unused-build.stamp:
|
|
|
|
|
# BUILDDIR=`pwd` && \
|
|
|
|
|
# cd $(srcdir)/tmpl && \
|
|
|
|
|
# ln -sf gstreamer-unused.sgml \
|
|
|
|
|
# $$BUILDDIR/tmpl/gstreamer-@GST_MAJORMINOR@-unused.sgml
|
|
|
|
|
# touch unused-build.stamp
|
|
|
|
|
|
|
|
|
|
# these rules are added to create parallel docs using GST_MAJORMINOR
|
|
|
|
|
#$(basefiles): gstreamer-@GST_MAJORMINOR@%: gstreamer%
|
|
|
|
|
# cp $< $@
|
|
|
|
|
|
|
|
|
|
#CLEANFILES = $(basefiles)
|
|
|
|
|
|
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
|
|
|
|
2001-12-12 06:08:44 +00:00
|
|
|
# The directory 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.
|
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_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.
|
2004-04-16 22:59:16 +00:00
|
|
|
MKDB_OPTIONS=--sgml-mode --ignore-files=parse
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# Extra options to supply to gtkdoc-fixref.
|
|
|
|
|
FIXXREF_OPTIONS=
|
|
|
|
|
|
|
|
|
|
# Used for dependencies.
|
|
|
|
|
HFILE_GLOB=$(DOC_SOURCE_DIR)/*.h
|
|
|
|
|
CFILE_GLOB=$(DOC_SOURCE_DIR)/*.c
|
|
|
|
|
|
|
|
|
|
# this is a wingo addition
|
2002-09-13 15:14:45 +00:00
|
|
|
# thomasvs: another nice wingo addition would be an explanation on why
|
|
|
|
|
# this is useful ;)
|
2003-05-18 15:04:26 +00:00
|
|
|
|
|
|
|
|
#SCANOBJ_DEPS = $(top_builddir)/gst/elements/libgstelements.la \
|
|
|
|
|
# $(top_builddir)/gst/schedulers/libgstbasicomegascheduler.la
|
2005-06-24 18:16:14 +00:00
|
|
|
SCANOBJ_DEPS = \
|
|
|
|
|
$(top_builddir)/gst/elements/libgstelements.la \
|
|
|
|
|
$(top_builddir)/gst/base/libgstbase-@GST_MAJORMINOR@.la
|
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 \
|
|
|
|
|
gst-i18n-lib.h \
|
|
|
|
|
gst-i18n-app.h \
|
|
|
|
|
gst_private.h \
|
|
|
|
|
gstdata_private.h \
|
|
|
|
|
gstarch.h \
|
|
|
|
|
cothreads.h \
|
2004-04-08 14:45:13 +00:00
|
|
|
cothreads_compat.h \
|
|
|
|
|
gthread-cothreads.h \
|
2004-11-07 19:31:39 +00:00
|
|
|
faircothreads.h \
|
2004-04-08 14:45:13 +00:00
|
|
|
types.h \
|
|
|
|
|
grammar.tab.h \
|
2004-04-08 15:14:27 +00:00
|
|
|
gstmarshal.h \
|
2004-04-29 00:32:28 +00:00
|
|
|
gstaggregator.h \
|
|
|
|
|
gstbufferstore.h \
|
|
|
|
|
gstfdsink.h \
|
|
|
|
|
gstfdsrc.h \
|
|
|
|
|
gstidentity.h \
|
|
|
|
|
gstmd5sink.h \
|
|
|
|
|
gstmultifilesrc.h \
|
2004-06-26 13:11:31 +00:00
|
|
|
gstmultifdsink.h \
|
2004-04-29 00:32:28 +00:00
|
|
|
gstpipefilter.h \
|
|
|
|
|
gstshaper.h \
|
|
|
|
|
gststatistics.h \
|
|
|
|
|
gsttee.h \
|
|
|
|
|
gsttypefindelement.h \
|
|
|
|
|
gstspider.h \
|
|
|
|
|
gstspideridentity.h \
|
|
|
|
|
gstsearchfuncs.h \
|
|
|
|
|
gstxmlregistry.h
|
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).
|
|
|
|
|
content_files =
|
|
|
|
|
|
|
|
|
|
# Other files to distribute.
|
|
|
|
|
extra_files =
|
|
|
|
|
|
|
|
|
|
# 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-02-11 10:00:15 +00:00
|
|
|
GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS) $(POPT_CFLAGS) -I$(top_builddir)
|
|
|
|
|
GTKDOC_LIBS = $(GST_OBJ_LIBS) $(POPT_LIBS) $(SCANOBJ_DEPS)
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
|
|
|
|
|
GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
|
|
|
|
|
|
|
|
|
|
# If you need to override some of the declarations, place them in this file
|
|
|
|
|
# and uncomment this line.
|
2005-03-29 14:12:48 +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
|
