doc fixen

Original commit message from CVS:
doc fixen
This commit is contained in:
Andy Wingo 2002-07-11 19:40:06 +00:00
parent e9e2348e6e
commit 30879f4362
14 changed files with 274 additions and 210 deletions

View file

@ -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

View file

@ -44,6 +44,7 @@ Get the current stack frame.
@jmp:
@top_sp:
@pc:
@magic_number:
<!-- ##### STRUCT cothread_context ##### -->
<para>

View file

@ -166,48 +166,6 @@ Gets the bufferpool private data.
@buf: a #GstBuffer to get bufferpool's private data of
<!-- ##### MACRO GST_BUFFER_LOCK ##### -->
<para>
Obtains a lock on the object, making serialization possible.
</para>
@buf: a #GstBuffer to lock
<!-- ##### MACRO GST_BUFFER_TRYLOCK ##### -->
<para>
Tries to obtain a lock on the buffer.
If it can't get immediately, will return FALSE.
</para>
@buf: a #GstBuffer to try to lock
<!-- ##### MACRO GST_BUFFER_UNLOCK ##### -->
<para>
Releases a lock on the buffer.
</para>
@buf: a #GstBuffer to unlock
<!-- ##### MACRO GST_BUFFER_PARENT ##### -->
<para>
Gets the parent of this buffer. The parent is set on sub-buffers.
</para>
@buf: a #GstBuffer to get parent of
<!-- ##### MACRO GST_BUFFER_MAXAGE ##### -->
<para>
Gets the maximum age of a buffer.
</para>
@buf: a #GstBuffer to get maximum age of
<!-- ##### MACRO GST_BUFFER_COPY_FUNC ##### -->
<para>
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
<!-- ##### USER_FUNCTION GstBufferCopyFunc ##### -->
<para>
This supplied function is used to copy the buffer contents.
</para>
@srcbuf: a #GstBuffer to copy from
@Returns: a newly allocated #GstBuffer copy of srcbuf
<!-- ##### USER_FUNCTION GstBufferFreeFunc ##### -->
<para>
This supplied function is called when the buffer data has to be freed.
</para>
@buf: a #GstBuffer to clear the buffer data of
<!-- ##### ENUM GstBufferFlag ##### -->
<para>
This enumeration type describes the flags that can be used for a buffer.
</para>
@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
<!-- ##### STRUCT GstBuffer ##### -->
<para>
</para>
@data_type:
@lock:
@data:
@size:
@maxsize:
@offset:
@timestamp:
@maxage:
@parent:
@offset:
@pool:
@pool_private:
@free:
@copy:
<!-- ##### FUNCTION gst_buffer_new ##### -->
<para>
@ -295,7 +217,7 @@ This enumeration type describes the flags that can be used for a buffer.
@location:
<!-- ##### FUNCTION gst_buffer_copy ##### -->
<!-- ##### MACRO gst_buffer_copy ##### -->
<para>
</para>
@ -315,49 +237,35 @@ This enumeration type describes the flags that can be used for a buffer.
@Returns:
<!-- ##### FUNCTION gst_buffer_append ##### -->
<!-- ##### MACRO gst_buffer_ref ##### -->
<para>
</para>
@buffer:
@append:
@Returns:
<!-- # Unused Parameters # -->
@buf:
@buf2:
<!-- ##### FUNCTION gst_buffer_ref ##### -->
<para>
</para>
<!-- # Unused Parameters # -->
@buffer:
<!-- ##### FUNCTION gst_buffer_ref_by_count ##### -->
<!-- ##### MACRO gst_buffer_ref_by_count ##### -->
<para>
</para>
@buf:
@c:
<!-- # Unused Parameters # -->
@buffer:
@count:
<!-- ##### FUNCTION gst_buffer_unref ##### -->
<para>
</para>
@buffer:
<!-- ##### FUNCTION gst_buffer_destroy ##### -->
<!-- ##### MACRO gst_buffer_unref ##### -->
<para>
</para>
@buf:
<!-- # Unused Parameters # -->
@buffer:

View file

@ -69,10 +69,11 @@ is typically used when a plugin wants to write into a memory area provided by an
</para>
@lock:
@buffer_free:
@data:
@active:
@buffer_new:
@buffer_copy:
@destroy_hook:
@buffer_free:
@user_data:
<!-- ##### USER_FUNCTION GstBufferPoolBufferNewFunction ##### -->
@ -81,36 +82,12 @@ The function will be called when a buffer must be allocated from the pool.
</para>
@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.
<!-- ##### USER_FUNCTION GstBufferPoolDestroyHook ##### -->
<para>
Will be called when the bufferpool is destroyed so that the owner of the pool
can perform necessary cleanup.
</para>
@pool: The pool that is being destroyed
@user_data: user data as set on th bufferpool
<!-- ##### MACRO GST_BUFFER_POOL_UNLOCK ##### -->
<para>
Lock the given bufferpool.
</para>
@pool: The pool to lock.
<!-- ##### MACRO GST_BUFFER_POOL_LOCK ##### -->
<para>
Unlock the given bufferpool.
</para>
@pool: the bufferpool to unlock.
<!-- # Unused Parameters # -->
@location: the location (offset) of the buffer to allocate
<!-- ##### FUNCTION gst_buffer_pool_new ##### -->
@ -118,42 +95,46 @@ Unlock the given bufferpool.
</para>
@free:
@copy:
@buffer_create:
@buffer_copy:
@buffer_free:
@user_data:
@Returns:
<!-- ##### FUNCTION gst_buffer_pool_ref ##### -->
<!-- ##### MACRO gst_buffer_pool_ref ##### -->
<para>
</para>
@buf:
<!-- # Unused Parameters # -->
@pool:
<!-- ##### FUNCTION gst_buffer_pool_ref_by_count ##### -->
<!-- ##### MACRO gst_buffer_pool_ref_by_count ##### -->
<para>
</para>
@buf:
@c:
<!-- # Unused Parameters # -->
@pool:
@count:
<!-- ##### FUNCTION gst_buffer_pool_unref ##### -->
<!-- ##### MACRO gst_buffer_pool_unref ##### -->
<para>
</para>
@pool:
@buf:
<!-- # Unused Parameters # -->
@buffer:
<!-- ##### FUNCTION gst_buffer_pool_destroy ##### -->
<para>
</para>
@pool:
@buffer:
<!-- ##### FUNCTION gst_buffer_pool_get_default ##### -->
@ -161,10 +142,12 @@ Unlock the given bufferpool.
</para>
@buffer_size:
@pool_size:
@size:
@numbuffers:
@Returns:
<!-- # Unused Parameters # -->
@buffer_size:
@pool_size:
@oldpool:
@ -188,39 +171,3 @@ Unlock the given bufferpool.
@user_data:
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_copy_function ##### -->
<para>
</para>
@pool:
@copy:
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_free_function ##### -->
<para>
</para>
@pool:
@destroy:
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_new_function ##### -->
<para>
</para>
@pool:
@create:
<!-- ##### FUNCTION gst_buffer_pool_set_destroy_hook ##### -->
<para>
</para>
@pool:
@destroy:

View file

@ -21,4 +21,8 @@ The base structure
</para>
@type: The type of this data.
@refcount:
@flags:
@free:
@copy:

View file

@ -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:
<!-- ##### MACRO GST_EVENT_TYPE ##### -->
<para>
@ -223,20 +224,14 @@ The event data structure.
@Returns:
<!-- ##### FUNCTION gst_event_copy ##### -->
<!-- ##### MACRO gst_event_copy ##### -->
<para>
</para>
@event:
@ev:
@Returns:
<!-- ##### FUNCTION gst_event_free ##### -->
<para>
</para>
<!-- # Unused Parameters # -->
@event:

View file

@ -232,16 +232,6 @@ The signature of a convert function.
@Returns: TRUE if the conversion could be performed.
<!-- ##### USER_FUNCTION GstPadDispatcherFunc ##### -->
<para>
The signature of the dispatcher callback.
</para>
@pad: The pad that is being dispatched
@data: user data
@Returns: TRUE if no further pads need to be processed
<!-- ##### USER_FUNCTION GstPadIntConnFunction ##### -->
<para>
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:
<!-- ##### USER_FUNCTION GstPadQueryFunction ##### -->
<para>

View file

@ -265,6 +265,16 @@ An entry hols one key/value pair.
@props2:
<!-- ##### FUNCTION gst_props_has_property ##### -->
<para>
</para>
@props:
@name:
@Returns:
<!-- ##### FUNCTION gst_props_normalize ##### -->
<para>

View file

@ -467,8 +467,7 @@ GstIdentity
<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Long_Description ##### -->
<para>
MD5 Sink can be used to automate regression tests on media pipelines by
computing a hash on the resulting buffers.
</para>
@ -479,7 +478,7 @@ computing a hash on the resulting buffers.
<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Short_Description ##### -->
Compute a hash on buffer data.
<!-- ##### SECTION ./tmpl/gstmd5sink.sgml:Title ##### -->
@ -1031,6 +1030,27 @@ g_print messages.
@klass:
<!-- ##### MACRO GST_BUFFER_LOCK ##### -->
<para>
Obtains a lock on the object, making serialization possible.
</para>
@buf: a #GstBuffer to lock
<!-- ##### MACRO GST_BUFFER_MAXAGE ##### -->
<para>
Gets the maximum age of a buffer.
</para>
@buf: a #GstBuffer to get maximum age of
<!-- ##### MACRO GST_BUFFER_PARENT ##### -->
<para>
Gets the parent of this buffer. The parent is set on sub-buffers.
</para>
@buf: a #GstBuffer to get parent of
<!-- ##### MACRO GST_BUFFER_POOL ##### -->
<para>
@ -1038,6 +1058,28 @@ g_print messages.
@buf:
<!-- ##### MACRO GST_BUFFER_POOL_LOCK ##### -->
<para>
Unlock the given bufferpool.
</para>
@pool: the bufferpool to unlock.
<!-- ##### MACRO GST_BUFFER_POOL_UNLOCK ##### -->
<para>
Lock the given bufferpool.
</para>
@pool: The pool to lock.
<!-- ##### MACRO GST_BUFFER_TRYLOCK ##### -->
<para>
Tries to obtain a lock on the buffer.
If it can't get immediately, will return FALSE.
</para>
@buf: a #GstBuffer to try to lock
<!-- ##### MACRO GST_BUFFER_TYPE ##### -->
<para>
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
<!-- ##### MACRO GST_BUFFER_UNLOCK ##### -->
<para>
Releases a lock on the buffer.
</para>
@buf: a #GstBuffer to unlock
<!-- ##### MACRO GST_CAPS_LOCK ##### -->
<para>
Lock the caps structure
@ -2964,6 +3014,35 @@ The frequency.
</para>
<!-- ##### USER_FUNCTION GstBufferCopyFunc ##### -->
<para>
This supplied function is used to copy the buffer contents.
</para>
@srcbuf: a #GstBuffer to copy from
@Returns: a newly allocated #GstBuffer copy of srcbuf
<!-- ##### ENUM GstBufferFlag ##### -->
<para>
This enumeration type describes the flags that can be used for a buffer.
</para>
@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
<!-- ##### USER_FUNCTION GstBufferFreeFunc ##### -->
<para>
This supplied function is called when the buffer data has to be freed.
</para>
@buf: a #GstBuffer to clear the buffer data of
<!-- ##### USER_FUNCTION GstBufferPoolCreateFunction ##### -->
<para>
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
<!-- ##### USER_FUNCTION GstBufferPoolDestroyHook ##### -->
<para>
Will be called when the bufferpool is destroyed so that the owner of the pool
can perform necessary cleanup.
</para>
@pool: The pool that is being destroyed
@user_data: user data as set on th bufferpool
<!-- ##### ENUM GstCapsDefinition ##### -->
<para>
@ -3598,6 +3686,15 @@ Indicates this pad is active
<<<<<<< gstreamer-unused.sgml
<!-- ##### USER_FUNCTION GstPadDispatcherFunc ##### -->
<para>
The signature of the dispatcher callback.
</para>
@pad: The pad that is being dispatched
@data: user data
@Returns: TRUE if no further pads need to be processed
<!-- ##### USER_FUNCTION GstPadEOSFunction ##### -->
<para>
The function that will be called in an EOS case.
@ -5234,6 +5331,24 @@ must be defined to activate the tracing functionality.
@buffer:
@meta:
<!-- ##### FUNCTION gst_buffer_append ##### -->
<para>
</para>
@buffer:
@append:
@Returns:
@buf:
@buf2:
<!-- ##### FUNCTION gst_buffer_destroy ##### -->
<para>
</para>
@buffer:
<!-- ##### FUNCTION gst_buffer_get_first_meta ##### -->
<para>
@ -5250,6 +5365,13 @@ must be defined to activate the tracing functionality.
@buffer:
@Returns:
<!-- ##### FUNCTION gst_buffer_pool_destroy ##### -->
<para>
</para>
@pool:
<!-- ##### FUNCTION gst_buffer_pool_destroy_buffer ##### -->
<para>
@ -5266,6 +5388,30 @@ must be defined to activate the tracing functionality.
@pool:
@Returns:
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_copy_function ##### -->
<para>
</para>
@pool:
@copy:
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_free_function ##### -->
<para>
</para>
@pool:
@destroy:
<!-- ##### FUNCTION gst_buffer_pool_set_buffer_new_function ##### -->
<para>
</para>
@pool:
@create:
<!-- ##### FUNCTION gst_buffer_pool_set_create_function ##### -->
<para>
@ -5284,6 +5430,14 @@ must be defined to activate the tracing functionality.
@destroy:
@user_data:
<!-- ##### FUNCTION gst_buffer_pool_set_destroy_hook ##### -->
<para>
</para>
@pool:
@destroy:
<!-- ##### FUNCTION gst_buffer_remove_meta ##### -->
<para>
@ -5707,6 +5861,13 @@ must be defined to activate the tracing functionality.
@esdsink:
<!-- ##### FUNCTION gst_event_free ##### -->
<para>
</para>
@event:
<!-- ##### FUNCTION gst_event_new_info ##### -->
<para>

View file

@ -4,7 +4,6 @@ GstSystemClock
<!-- ##### SECTION Short_Description ##### -->
A default clock that uses the current system time
<!-- ##### SECTION Long_Description ##### -->
<para>
The System clock is an implementation of GstClock using the

View file

@ -43,3 +43,20 @@ Thread flags:
@Returns:
<!-- ##### SIGNAL GstThread::shutdown ##### -->
<para>
</para>
@gstthread: the object which received the signal.
<!-- ##### ARG GstThread:schedpolicy ##### -->
<para>
</para>
<!-- ##### ARG GstThread:priority ##### -->
<para>
</para>

View file

@ -115,3 +115,15 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
@arg2:
<!-- # Unused Parameters # -->
@gstelement: the object which received the signal.
<!-- ##### SIGNAL GstXML::object-loaded ##### -->
<para>
</para>
@gstxml: the object which received the signal.
@arg1:
@arg2:
<!-- # Unused Parameters # -->
@gstelement: the object which received the signal.

View file

@ -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

View file

@ -7,7 +7,7 @@
<!-- This file is for customizing the default XSL stylesheets. -->
<!-- We include them here (this one is for print output): -->
<xsl:import
href="http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl"/>
href="http://docbook.sourceforge.net/release/xsl/1.49/fo/docbook.xsl"/>
<!-- .. and customize them here: -->
<xsl:include href="ulink.xsl"/>