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
|
|
|
|
|
|
|
|
|
|
# The name of the module.
|
|
|
|
|
DOC_MODULE=gstreamer
|
|
|
|
|
|
|
|
|
|
# The top-level SGML file.
|
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
|
|
|
|
|
|
|
|
# The directory containing the source code (if it contains documentation).
|
|
|
|
|
DOC_SOURCE_DIR=$(top_srcdir)/gst
|
|
|
|
|
|
2001-01-02 02:16:24 +00:00
|
|
|
EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt $(DOC_MAIN_SGML_FILE)
|
2000-05-12 07:15:03 +00:00
|
|
|
|
2000-08-18 20:35:48 +00:00
|
|
|
HTML_DIR=$(datadir)/gstreamer/html
|
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-01-19 22:15:21 +00:00
|
|
|
GST_LIBS += ../../gst/elements/libgstelements.la
|
|
|
|
|
|
|
|
|
|
|
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
|
|
|
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
|
|
|
|
|
|
|
|
|
|
tmpl_sources = \
|
2000-03-27 19:53:43 +00:00
|
|
|
tmpl/cothreads.sgml \
|
|
|
|
|
tmpl/gst.sgml \
|
2000-12-30 17:13:08 +00:00
|
|
|
tmpl/gstinfo.sgml \
|
|
|
|
|
tmpl/gstautoplug.sgml \
|
|
|
|
|
tmpl/gstscheduler.sgml \
|
|
|
|
|
tmpl/gstprops.sgml \
|
|
|
|
|
tmpl/gstcaps.sgml \
|
2000-03-27 19:53:43 +00:00
|
|
|
tmpl/gstbin.sgml \
|
|
|
|
|
tmpl/gstbuffer.sgml \
|
2000-10-22 16:27:21 +00:00
|
|
|
tmpl/gstbufferpool.sgml \
|
2000-03-27 19:53:43 +00:00
|
|
|
tmpl/gstdisksrc.sgml \
|
|
|
|
|
tmpl/gstelement.sgml \
|
|
|
|
|
tmpl/gstfakesink.sgml \
|
|
|
|
|
tmpl/gstfakesrc.sgml \
|
|
|
|
|
tmpl/gstfdsink.sgml \
|
|
|
|
|
tmpl/gstfdsrc.sgml \
|
|
|
|
|
tmpl/gsthttpsrc.sgml \
|
|
|
|
|
tmpl/gstidentity.sgml \
|
|
|
|
|
tmpl/gstlog.sgml \
|
|
|
|
|
tmpl/gstmeta.sgml \
|
|
|
|
|
tmpl/gstobject.sgml \
|
|
|
|
|
tmpl/gstpad.sgml \
|
|
|
|
|
tmpl/gstpipeline.sgml \
|
|
|
|
|
tmpl/gstplugin.sgml \
|
|
|
|
|
tmpl/gstqueue.sgml \
|
|
|
|
|
tmpl/gstreamer-unused.sgml \
|
|
|
|
|
tmpl/gstsinesrc.sgml \
|
|
|
|
|
tmpl/gsttee.sgml \
|
|
|
|
|
tmpl/gstthread.sgml \
|
|
|
|
|
tmpl/gsttrace.sgml \
|
|
|
|
|
tmpl/gsttype.sgml \
|
|
|
|
|
tmpl/gstutils.sgml \
|
|
|
|
|
tmpl/gstxml.sgml \
|
2001-04-12 18:11:19 +00:00
|
|
|
tmpl/spectrum.sgml
|
2000-02-02 06:26:44 +00:00
|
|
|
|
|
|
|
|
gstreamer_docdir = $(HTML_DIR)
|
|
|
|
|
gstreamer_doc_DATA = \
|
|
|
|
|
gstreamer.html \
|
|
|
|
|
gstreamer.types \
|
2001-01-01 14:06:25 +00:00
|
|
|
gstreamer.hierarchy \
|
2000-02-02 06:26:44 +00:00
|
|
|
gstreamer-sections.txt
|
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
|
|
|
|
|
|
|
|
SCANOBJS_FILES = \
|
|
|
|
|
$(DOC_MODULE).signals \
|
|
|
|
|
$(DOC_MODULE).hierarchy \
|
|
|
|
|
$(DOC_MODULE).args
|
|
|
|
|
|
2000-02-02 06:26:44 +00:00
|
|
|
if HAVE_GTK_DOC
|
|
|
|
|
gstreamer.html: html/book1.html
|
|
|
|
|
-cd $(srcdir) && cp html/book1.html gstreamer.html
|
|
|
|
|
else
|
|
|
|
|
gstreamer.html:
|
|
|
|
|
endif
|
|
|
|
|
|
|
|
|
|
html/book1.html: sgml/gstreamer-doc.bottom
|
|
|
|
|
$(MAKE) html
|
|
|
|
|
|
|
|
|
|
sgml/gstreamer-doc.bottom: $(tmpl_sources)
|
|
|
|
|
$(MAKE) sgml
|
|
|
|
|
|
2000-03-27 19:53:43 +00:00
|
|
|
gstreamer-decl.txt:
|
2001-01-02 01:33:01 +00:00
|
|
|
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers=""
|
2000-03-27 19:53:43 +00:00
|
|
|
|
2000-05-12 07:15:03 +00:00
|
|
|
scanobj: $(srcdir)/$(DOC_MODULE).types
|
2001-01-19 22:15:21 +00:00
|
|
|
rm gstreamer-scan.o; ln -s gstreamer-scan.lo gstreamer-scan.o
|
2001-05-31 18:03:10 +00:00
|
|
|
cd ../../gst/;$(MAKE) libgst.la
|
|
|
|
|
cd ../../gst/elements/;$(MAKE) libgstelements.la
|
2001-06-04 11:25:19 +00:00
|
|
|
# The LD env-var below is a nasty hack to make this work on versions of gtkdoc-scanobj which don't understand libtool
|
|
|
|
|
env CC="$(LIBTOOL) $(CC)" LD="cp gstreamer-scan.lo gstreamer-scan.o;$(LIBTOOL) $(CC)" CFLAGS="$(LIBGST_CFLAGS) $(GLIB_CFLAGS) $(XML_CFLAGS) -I../../" LDFLAGS="$(GST_LIBS)"\
|
2001-01-19 22:15:21 +00:00
|
|
|
gtkdoc-scanobj --module=$(DOC_MODULE)
|
2000-11-07 21:18:52 +00:00
|
|
|
gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
|
2000-10-22 16:27:21 +00:00
|
|
|
|
2001-01-02 01:33:01 +00:00
|
|
|
tmpl: scanobj gstreamer-decl.txt
|
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
|
|
|
gtkdoc-mktmpl --module=$(DOC_MODULE)
|
|
|
|
|
|
2000-03-27 19:53:43 +00:00
|
|
|
sgml: tmpl
|
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
|
|
|
gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)
|
|
|
|
|
|
2000-12-28 21:42:23 +00:00
|
|
|
html: 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
|
|
|
if ! test -d html ; then mkdir html ; fi
|
|
|
|
|
-cd html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
|
|
|
|
|
|
|
|
|
|
clean-local:
|
2000-03-27 19:53:43 +00:00
|
|
|
rm -f *~ *.bak *.signals *-unused.txt *.args
|
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
|
|
|
|
|
|
|
|
maintainer-clean-local: clean
|
|
|
|
|
rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
|
|
|
|
|
|
2001-01-02 01:33:01 +00:00
|
|
|
install-data-local: gstreamer.html
|
2000-02-02 06:26:44 +00:00
|
|
|
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
|
|
|
|
|
(installfiles=`echo $(srcdir)/html/*.html`; \
|
|
|
|
|
if test "$$installfiles" = '$(srcdir)/html/*.html'; \
|
|
|
|
|
then echo '-- Nothing to install' ; \
|
|
|
|
|
else \
|
|
|
|
|
for i in $$installfiles; do \
|
|
|
|
|
echo '-- Installing '$$i ; \
|
|
|
|
|
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
|
|
|
|
|
done; \
|
|
|
|
|
echo '-- Installing $(srcdir)/html/index.sgml' ; \
|
|
|
|
|
$(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
|
|
|
|
|
echo '-- Fixing Crossreferences' ; \
|
|
|
|
|
gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \
|
|
|
|
|
fi)
|
|
|
|
|
|
2001-01-02 01:33:01 +00:00
|
|
|
dist-hook: gstreamer.html
|
2001-05-31 18:03:10 +00:00
|
|
|
if ! test -d $(distdir)/html ; then mkdir $(distdir)/html ; fi
|
|
|
|
|
if ! test -d $(distdir)/sgml ; then mkdir $(distdir)/sgml ; fi
|
|
|
|
|
if ! test -d $(distdir)/tmpl ; then mkdir $(distdir)/tmpl ; fi
|
2000-02-02 06:26:44 +00:00
|
|
|
-cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
|
|
|
|
|
-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
|
|
|
|
|
-cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
|
|
|
|
|
-cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/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-01-02 01:33:01 +00:00
|
|
|
.PHONY : html sgml tmpl
|
