From 30879f4362f5bc35ed1f671a88aa37e2fb2e6da4 Mon Sep 17 00:00:00 2001 From: Andy Wingo Date: Thu, 11 Jul 2002 19:40:06 +0000 Subject: [PATCH] doc fixen Original commit message from CVS: doc fixen --- docs/building-the-docs-on-debian | 19 ++++ docs/gst/tmpl/cothreads.sgml | 1 + docs/gst/tmpl/gstbuffer.sgml | 114 +++--------------------- docs/gst/tmpl/gstbufferpool.sgml | 107 ++++++----------------- docs/gst/tmpl/gstdata.sgml | 4 + docs/gst/tmpl/gstevent.sgml | 13 +-- docs/gst/tmpl/gstpad.sgml | 11 +-- docs/gst/tmpl/gstprops.sgml | 10 +++ docs/gst/tmpl/gstreamer-unused.sgml | 167 +++++++++++++++++++++++++++++++++++- docs/gst/tmpl/gstsystemclock.sgml | 1 - docs/gst/tmpl/gstthread.sgml | 17 ++++ docs/gst/tmpl/gstxml.sgml | 12 +++ docs/manuals.mak | 6 +- docs/xsl/fo.xsl | 2 +- 14 files changed, 274 insertions(+), 210 deletions(-) create mode 100644 docs/building-the-docs-on-debian diff --git a/docs/building-the-docs-on-debian b/docs/building-the-docs-on-debian new file mode 100644 index 0000000..288f3cd --- /dev/null +++ b/docs/building-the-docs-on-debian @@ -0,0 +1,19 @@ +OK, so Debian's passivetex and xmltex packages are sucking right now, I think. +Here's what I had to do to get the PDF output to work properly. + +# rm -rf /usr/share/texmf/tex/xmltex/contrib/passivetex +# cd /usr/share/texmf/tex/latex +# wget http://www.tei-c.org.uk/Software/passivetex/passivetex.zip +# unzip passivetex.zip +# rm passivetex.zip +# cd /usr/share/texmf/tex/xmltex/base +# wget http://www.tei-c.org.uk/Software/passivetex/xmltex.tex +# mktexlsr +# cd /var/lib/texmf/web2c +# pdftex -ini "&pdflatex" pdfxmtex.ini +# cp 95NonPath /etc/texmf/texmf.d +# update-texmf + +Sheesh. Don't ask how long that took to figure out. + +-- Andy Wingo, 11 July 2002 \ No newline at end of file diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index 1896db6..2bd0141 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -44,6 +44,7 @@ Get the current stack frame. @jmp: @top_sp: @pc: +@magic_number: diff --git a/docs/gst/tmpl/gstbuffer.sgml b/docs/gst/tmpl/gstbuffer.sgml index 4c8d7c9..27052e4 100644 --- a/docs/gst/tmpl/gstbuffer.sgml +++ b/docs/gst/tmpl/gstbuffer.sgml @@ -166,48 +166,6 @@ Gets the bufferpool private data. @buf: a #GstBuffer to get bufferpool's private data of - - -Obtains a lock on the object, making serialization possible. - - -@buf: a #GstBuffer to lock - - - - -Tries to obtain a lock on the buffer. -If it can't get immediately, will return FALSE. - - -@buf: a #GstBuffer to try to lock - - - - -Releases a lock on the buffer. - - - -@buf: a #GstBuffer to unlock - - - - -Gets the parent of this buffer. The parent is set on sub-buffers. - - -@buf: a #GstBuffer to get parent of - - - - -Gets the maximum age of a buffer. - - -@buf: a #GstBuffer to get maximum age of - - Calls the buffer-specific copy function on the given buffer. @@ -224,55 +182,19 @@ Calls the buffer-specific free function on the given buffer. @buf: a #GstBuffer to free - - -This supplied function is used to copy the buffer contents. - - -@srcbuf: a #GstBuffer to copy from -@Returns: a newly allocated #GstBuffer copy of srcbuf - - - - -This supplied function is called when the buffer data has to be freed. - - -@buf: a #GstBuffer to clear the buffer data of - - - - -This enumeration type describes the flags that can be used for a buffer. - - -@GST_BUFFER_READONLY: buffer is read-only -@GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer -@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unreferenced -@GST_BUFFER_DISCONTINOUS: This buffer is the first one after a discontinuity in the stream -@GST_BUFFER_KEY_UNIT: This buffer holds a key unit, a unit that can be decoded independently - of other buffers -@GST_BUFFER_PREROLL: This buffer should be decoded but not rendered, it is mainly used - to resynchronise the stream - @data_type: -@lock: @data: @size: @maxsize: -@offset: @timestamp: -@maxage: -@parent: +@offset: @pool: @pool_private: -@free: -@copy: @@ -295,7 +217,7 @@ This enumeration type describes the flags that can be used for a buffer. @location: - + @@ -315,49 +237,35 @@ This enumeration type describes the flags that can be used for a buffer. @Returns: - + -@buffer: -@append: -@Returns: - @buf: -@buf2: - - - - - - - + @buffer: - + +@buf: +@c: + @buffer: @count: - - - - - -@buffer: - - - + +@buf: + @buffer: diff --git a/docs/gst/tmpl/gstbufferpool.sgml b/docs/gst/tmpl/gstbufferpool.sgml index 2178525..69f56d4 100644 --- a/docs/gst/tmpl/gstbufferpool.sgml +++ b/docs/gst/tmpl/gstbufferpool.sgml @@ -69,10 +69,11 @@ is typically used when a plugin wants to write into a memory area provided by an -@lock: -@buffer_free: +@data: +@active: +@buffer_new: @buffer_copy: -@destroy_hook: +@buffer_free: @user_data: @@ -81,36 +82,12 @@ The function will be called when a buffer must be allocated from the pool. @pool: The pool allocating the buffer -@location: the location (offset) of the buffer to allocate +@offset: @size: The size of the allocated buffer @user_data: user data as set on the bufferpool @Returns: A new buffer with the given parameters. - - - - -Will be called when the bufferpool is destroyed so that the owner of the pool -can perform necessary cleanup. - - -@pool: The pool that is being destroyed -@user_data: user data as set on th bufferpool - - - - -Lock the given bufferpool. - - -@pool: The pool to lock. - - - - -Unlock the given bufferpool. - - -@pool: the bufferpool to unlock. + +@location: the location (offset) of the buffer to allocate @@ -118,42 +95,46 @@ Unlock the given bufferpool. +@free: +@copy: +@buffer_create: +@buffer_copy: +@buffer_free: +@user_data: @Returns: - + +@buf: + @pool: - + +@buf: +@c: + @pool: @count: - + -@pool: +@buf: -@buffer: - - - - - - - @pool: +@buffer: @@ -161,10 +142,12 @@ Unlock the given bufferpool. -@buffer_size: -@pool_size: +@size: +@numbuffers: @Returns: +@buffer_size: +@pool_size: @oldpool: @@ -188,39 +171,3 @@ Unlock the given bufferpool. @user_data: - - - - - -@pool: -@copy: - - - - - - - -@pool: -@destroy: - - - - - - - -@pool: -@create: - - - - - - - -@pool: -@destroy: - - diff --git a/docs/gst/tmpl/gstdata.sgml b/docs/gst/tmpl/gstdata.sgml index 4f1c83b..429be79 100644 --- a/docs/gst/tmpl/gstdata.sgml +++ b/docs/gst/tmpl/gstdata.sgml @@ -21,4 +21,8 @@ The base structure @type: The type of this data. +@refcount: +@flags: +@free: +@copy: diff --git a/docs/gst/tmpl/gstevent.sgml b/docs/gst/tmpl/gstevent.sgml index a550bdf..d710355 100644 --- a/docs/gst/tmpl/gstevent.sgml +++ b/docs/gst/tmpl/gstevent.sgml @@ -41,6 +41,7 @@ The different major types of events. @GST_EVENT_QOS: a quality of service event @GST_EVENT_SEEK: a seek event. @GST_EVENT_FILLER: a dummy element that should be ignored by plugins +@GST_EVENT_SIZE: @@ -223,20 +224,14 @@ The event data structure. @Returns: - + -@event: +@ev: @Returns: - - - - - - - + @event: diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index 501e301..6a1cde6 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -232,16 +232,6 @@ The signature of a convert function. @Returns: TRUE if the conversion could be performed. - - -The signature of the dispatcher callback. - - -@pad: The pad that is being dispatched -@data: user data -@Returns: TRUE if no further pads need to be processed - - The signature of the internal pad connection function @@ -260,6 +250,7 @@ The different supported query types @GST_PAD_QUERY_TOTAL: Query the total stream time @GST_PAD_QUERY_POSITION: Query the current stream position @GST_PAD_QUERY_LATENCY: Query the latency on the pad +@GST_PAD_QUERY_JITTER: diff --git a/docs/gst/tmpl/gstprops.sgml b/docs/gst/tmpl/gstprops.sgml index aa13959..160f6d1 100644 --- a/docs/gst/tmpl/gstprops.sgml +++ b/docs/gst/tmpl/gstprops.sgml @@ -265,6 +265,16 @@ An entry hols one key/value pair. @props2: + + + + + +@props: +@name: +@Returns: + + diff --git a/docs/gst/tmpl/gstreamer-unused.sgml b/docs/gst/tmpl/gstreamer-unused.sgml index 5354aa4..664c2c4 100644 --- a/docs/gst/tmpl/gstreamer-unused.sgml +++ b/docs/gst/tmpl/gstreamer-unused.sgml @@ -467,8 +467,7 @@ GstIdentity -MD5 Sink can be used to automate regression tests on media pipelines by -computing a hash on the resulting buffers. + @@ -479,7 +478,7 @@ computing a hash on the resulting buffers. -Compute a hash on buffer data. + @@ -1031,6 +1030,27 @@ g_print messages. @klass: + + +Obtains a lock on the object, making serialization possible. + + +@buf: a #GstBuffer to lock + + + +Gets the maximum age of a buffer. + + +@buf: a #GstBuffer to get maximum age of + + + +Gets the parent of this buffer. The parent is set on sub-buffers. + + +@buf: a #GstBuffer to get parent of + @@ -1038,6 +1058,28 @@ g_print messages. @buf: + + +Unlock the given bufferpool. + + +@pool: the bufferpool to unlock. + + + +Lock the given bufferpool. + + +@pool: The pool to lock. + + + +Tries to obtain a lock on the buffer. +If it can't get immediately, will return FALSE. + + +@buf: a #GstBuffer to try to lock + Retrieves the type id of the data in the buffer. @@ -1045,6 +1087,14 @@ Retrieves the type id of the data in the buffer. @buf: GstBuffer + + +Releases a lock on the buffer. + + + +@buf: a #GstBuffer to unlock + Lock the caps structure @@ -2964,6 +3014,35 @@ The frequency. + + +This supplied function is used to copy the buffer contents. + + +@srcbuf: a #GstBuffer to copy from +@Returns: a newly allocated #GstBuffer copy of srcbuf + + + +This enumeration type describes the flags that can be used for a buffer. + + +@GST_BUFFER_READONLY: buffer is read-only +@GST_BUFFER_ORIGINAL: buffer is not a copy of another buffer +@GST_BUFFER_DONTFREE: do not try to free the data when this buffer is unreferenced +@GST_BUFFER_DISCONTINOUS: This buffer is the first one after a discontinuity in the stream +@GST_BUFFER_KEY_UNIT: This buffer holds a key unit, a unit that can be decoded independently + of other buffers +@GST_BUFFER_PREROLL: This buffer should be decoded but not rendered, it is mainly used + to resynchronise the stream + + + +This supplied function is called when the buffer data has to be freed. + + +@buf: a #GstBuffer to clear the buffer data of + The function called when a buffer has to be created for this pool. @@ -2983,6 +3062,15 @@ the pool. @buffer: the buffer to return @user_data: any user data + + +Will be called when the bufferpool is destroyed so that the owner of the pool +can perform necessary cleanup. + + +@pool: The pool that is being destroyed +@user_data: user data as set on th bufferpool + @@ -3598,6 +3686,15 @@ Indicates this pad is active <<<<<<< gstreamer-unused.sgml + + +The signature of the dispatcher callback. + + +@pad: The pad that is being dispatched +@data: user data +@Returns: TRUE if no further pads need to be processed + The function that will be called in an EOS case. @@ -5234,6 +5331,24 @@ must be defined to activate the tracing functionality. @buffer: @meta: + + + + + +@buffer: +@append: +@Returns: +@buf: +@buf2: + + + + + + +@buffer: + @@ -5250,6 +5365,13 @@ must be defined to activate the tracing functionality. @buffer: @Returns: + + + + + +@pool: + @@ -5266,6 +5388,30 @@ must be defined to activate the tracing functionality. @pool: @Returns: + + + + + +@pool: +@copy: + + + + + + +@pool: +@destroy: + + + + + + +@pool: +@create: + @@ -5284,6 +5430,14 @@ must be defined to activate the tracing functionality. @destroy: @user_data: + + + + + +@pool: +@destroy: + @@ -5707,6 +5861,13 @@ must be defined to activate the tracing functionality. @esdsink: + + + + + +@event: + diff --git a/docs/gst/tmpl/gstsystemclock.sgml b/docs/gst/tmpl/gstsystemclock.sgml index 978f745..cfb3ad1 100644 --- a/docs/gst/tmpl/gstsystemclock.sgml +++ b/docs/gst/tmpl/gstsystemclock.sgml @@ -4,7 +4,6 @@ GstSystemClock A default clock that uses the current system time - The System clock is an implementation of GstClock using the diff --git a/docs/gst/tmpl/gstthread.sgml b/docs/gst/tmpl/gstthread.sgml index 1a74de5..2fae7e4 100644 --- a/docs/gst/tmpl/gstthread.sgml +++ b/docs/gst/tmpl/gstthread.sgml @@ -43,3 +43,20 @@ Thread flags: @Returns: + + + + + +@gstthread: the object which received the signal. + + + + + + + + + + + diff --git a/docs/gst/tmpl/gstxml.sgml b/docs/gst/tmpl/gstxml.sgml index 90fea84..ff10c11 100644 --- a/docs/gst/tmpl/gstxml.sgml +++ b/docs/gst/tmpl/gstxml.sgml @@ -115,3 +115,15 @@ All GstElements can be serialized to an XML presentation and subsequently loaded @arg2: @gstelement: the object which received the signal. + + + + + + +@gstxml: the object which received the signal. +@arg1: +@arg2: + +@gstelement: the object which received the signal. + diff --git a/docs/manuals.mak b/docs/manuals.mak index e055f24..92263b7 100644 --- a/docs/manuals.mak +++ b/docs/manuals.mak @@ -45,8 +45,8 @@ $(DOC).fo: $(XML) $(PDFS) $(XSLFO) $(XSLFOMODS) mv -f $@-t $@ $(DOC).pdf: $(DOC).fo - pdfxmltex $< - pdfxmltex $< + pdfxmltex $< || true + pdfxmltex $< || true $(DOC).ps: $(DOC).pdf pdftops $< $@ @@ -93,6 +93,6 @@ $(DOC).tar.gz: distclean # Make pdf from xfig %.pdf: %.fig - fig2dev -Lpdf $< $@ + fig2dev -Lpdf $< images/$@ .PHONY: distclean clean all builddate diff --git a/docs/xsl/fo.xsl b/docs/xsl/fo.xsl index df23fe2..c96fddf 100644 --- a/docs/xsl/fo.xsl +++ b/docs/xsl/fo.xsl @@ -7,7 +7,7 @@ + href="http://docbook.sourceforge.net/release/xsl/1.49/fo/docbook.xsl"/> -- 2.7.4