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
|
|
|
|
|
|
2005-11-30 19:36:54 +00:00
|
|
|
BUILT_SOURCES=gstreamer.types
|
|
|
|
|
|
2004-01-28 12:16:51 +00:00
|
|
|
# for upload.mak
|
|
|
|
|
DOC=gstreamer
|
|
|
|
|
FORMATS=html
|
|
|
|
|
html: html-build.stamp
|
2006-04-29 00:36:47 +00:00
|
|
|
include $(top_srcdir)/common/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
|
|
|
# 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.
|
docs/: Correct fixxrefs options.
Original commit message from CVS:
* docs/gst/Makefile.am:
* docs/libs/Makefile.am:
Correct fixxrefs options.
* docs/plugins/Makefile.am:
* docs/plugins/gstreamer-plugins-docs.sgml:
* docs/plugins/gstreamer-plugins-sections.txt:
* plugins/elements/Makefile.am:
* plugins/elements/gstcapsfilter.c (gst_capsfilter_details):
* plugins/elements/gstcapsfilter.h (__GST_CAPSFILTER_H__,
GST_TYPE_CAPSFILTER, GST_CAPSFILTER, GST_CAPSFILTER_CLASS,
GST_IS_CAPSFILTER, GST_IS_CAPSFILTER_CLASS, GstCapsFilter,
GstCapsFilterClass, _GstCapsFilter, trans, filter_caps,
_GstCapsFilterClass, trans_class):
* plugins/elements/gstelements.c (name, rank, type, _elements):
* plugins/elements/gstidentity.c
(gst_identity_check_imperfect_timestamp,
gst_identity_check_imperfect_offset):
Document capsfilter and add doc-blurb to identity.
2007-05-06 18:27:25 +00:00
|
|
|
FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
|
2007-02-12 19:55:24 +00:00
|
|
|
--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib
|
2001-12-12 06:08:44 +00:00
|
|
|
|
2005-11-29 19:12: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
|
|
|
|
|
DOC_BUILD_DIR = $(top_builddir)/gst
|
|
|
|
|
|
|
|
|
|
HFILE_GLOB=$(top_srcdir)/gst/*.h $(top_srcdir)/libs/gst/*/*.h
|
|
|
|
|
CFILE_GLOB=$(top_srcdir)/gst/*.c $(top_srcdir)/libs/gst/*/*.c
|
2001-12-12 06:08:44 +00:00
|
|
|
|
2005-06-24 18:16:14 +00:00
|
|
|
SCANOBJ_DEPS = \
|
2005-11-29 19:12:30 +00:00
|
|
|
$(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
|
|
|
|
|
$(top_builddir)/libs/gst/net/libgstnet-@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 \
|
2005-09-20 06:28:33 +00:00
|
|
|
glib-compat.h \
|
2004-04-08 14:45:13 +00:00
|
|
|
grammar.tab.h \
|
gst/parse/: Make the parser reentrant and recursively callable. This requires flex >= 2.5.31, for older versions preg...
Original commit message from CVS:
Patch by: Marc-Andre Lureau <marcandre dot lureau at gmail dot com>
* gst/parse/Makefile.am:
* gst/parse/grammar.y:
* gst/parse/parse.l:
Make the parser reentrant and recursively callable. This requires flex
>= 2.5.31, for older versions pregenerated sources are used as we
can't bump the build dependency. Finally fixes #349180.
* gst/gstparse.c: (gst_parse_launch):
Drop the HAVE_MT_SAVE_FLEX #ifdefs as we always use a new enough flex
now anyway.
* docs/gst/Makefile.am:
* docs/gst/Makefile.am:
* gst/parse/grammar.tab.pre.c: (__gst_parse_strdup),
(__gst_parse_strfree), (__gst_parse_link_new),
(__gst_parse_link_free), (__gst_parse_chain_new),
(__gst_parse_chain_free), (SET_ERROR), (YYPRINTF),
(gst_parse_element_set), (gst_parse_free_link),
(gst_parse_found_pad), (gst_parse_perform_delayed_link),
(gst_parse_perform_link), (yytnamerr), (yysyntax_error), (yyerror),
(_gst_parse_launch):
* gst/parse/grammar.tab.pre.h:
* gst/parse/lex._gst_parse_yy.pre.c: (PRINT), (yy_get_next_buffer),
(yy_get_previous_state), (yy_try_NUL_trans), (input),
(_gst_parse_yyrestart), (_gst_parse_yy_switch_to_buffer),
(_gst_parse_yy_load_buffer_state), (_gst_parse_yy_create_buffer),
(_gst_parse_yy_delete_buffer), (_gst_parse_yy_init_buffer),
(_gst_parse_yy_flush_buffer), (_gst_parse_yypush_buffer_state),
(_gst_parse_yypop_buffer_state),
(_gst_parse_yyensure_buffer_stack), (_gst_parse_yy_scan_buffer),
(_gst_parse_yy_scan_string), (_gst_parse_yy_scan_bytes),
(yy_fatal_error), (_gst_parse_yyget_extra),
(_gst_parse_yyget_lineno), (_gst_parse_yyget_column),
(_gst_parse_yyget_in), (_gst_parse_yyget_out),
(_gst_parse_yyget_leng), (_gst_parse_yyget_text),
(_gst_parse_yyset_extra), (_gst_parse_yyset_lineno),
(_gst_parse_yyset_column), (_gst_parse_yyset_in),
(_gst_parse_yyset_out), (_gst_parse_yyget_debug),
(_gst_parse_yyset_debug), (_gst_parse_yyget_lval),
(_gst_parse_yyset_lval), (_gst_parse_yylex_init),
(yy_init_globals), (_gst_parse_yylex_destroy), (yy_flex_strncpy),
(yy_flex_strlen), (_gst_parse_yyalloc), (_gst_parse_yyrealloc),
(_gst_parse_yyfree):
If the installed flex version is too old use pre-generated parser
sources. These pre-generated parser sources are always updated when
the actual flex/bison sources change but require everybody who wants
to change something in the parser to have flex >= 2.5.31 installed.
2007-04-18 12:34:51 +00:00
|
|
|
grammar.tab.pre.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 \
|
2005-09-20 06:28:33 +00:00
|
|
|
gstmacros.h \
|
2004-04-29 00:32:28 +00:00
|
|
|
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 \
|
2005-09-20 06:28:33 +00:00
|
|
|
gsttrashstack.h \
|
2004-04-29 00:32:28 +00:00
|
|
|
gsttypefindelement.h \
|
|
|
|
|
gstspider.h \
|
|
|
|
|
gstspideridentity.h \
|
|
|
|
|
gstsearchfuncs.h \
|
2005-09-20 06:28:33 +00:00
|
|
|
gsttrashstack.h \
|
2004-04-29 00:32:28 +00:00
|
|
|
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).
|
2005-10-08 11:12:26 +00:00
|
|
|
content_files = running.xml
|
2001-12-12 06:08:44 +00:00
|
|
|
|
|
|
|
|
# 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-10-15 13:58:18 +00:00
|
|
|
GTKDOC_CFLAGS = $(GST_OBJ_CFLAGS)
|
Merged in popt removal + GOption addition patch from Ronald, bug #169772.
Original commit message from CVS:
2005-10-10 Andy Wingo <wingo@pobox.com>
Merged in popt removal + GOption addition patch from Ronald, bug
#169772.
* docs/gst/gstreamer-sections.txt: Add STATE_(UN)LOCK_FULL, move
GstElement macros around, remove popt-related symbols, add goption
stuff.
* configure.ac: Remove popt checks, require GLib 2.6 for GOption.
* docs/gst/Makefile.am:
* docs/libs/Makefile.am: No POPT_CFLAGS.
* examples/manual/Makefile.am:
* docs/manual/basics-init.xml: Doc updates with an example.
* gst/gst.c: (gst_init_get_option_group), (gst_init_check),
(gst_init), (parse_one_option), (parse_goption_arg):
* gst/gst.h: Removed gst_init_with_popt_table and friends. Took a
bit of hand merging and debugging to get the GOption stuff working
tho.
* tests/Makefile.am:
* tools/Makefile.am:
* tools/gst-inspect.c: (main):
* tools/gst-launch.c: (main):
* tools/gst-run.c: (main):
* tools/gst-xmlinspect.c: (main): Thanks Ronald!
2005-10-10 15:53:59 +00:00
|
|
|
GTKDOC_LIBS = $(GST_OBJ_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
|
