diff --git a/docs/gst/tmpl/cothreads.sgml b/docs/gst/tmpl/cothreads.sgml index fee77b9b35..42fdf498d8 100644 --- a/docs/gst/tmpl/cothreads.sgml +++ b/docs/gst/tmpl/cothreads.sgml @@ -2,11 +2,18 @@ cothreads - +userspace threads +Cothreads are a simple user-space method for switching between +subtasks. They're based on setjmp()/longjmp() in their current form. + + +Cothreads are used for loop-based elements that pull data instead +of being fed with data. They can also be used to pull a specific region +of data out of their src element. @@ -16,14 +23,14 @@ cothreads - +The default stack size of a cothread - +The maximum number of cothreads we are going to support. @@ -66,10 +73,11 @@ cothreads @threads: @nthreads: @current: +@data: - +the function that will be called when the cothread starts. @argc: @@ -79,14 +87,13 @@ cothreads - +Indicates the cothread is started - @Returns: @@ -129,3 +136,23 @@ cothreads @Returns: + + + + + +@thread: +@key: +@data: + + + + + + + +@thread: +@key: +@Returns: + + diff --git a/docs/gst/tmpl/gstbufferpool.sgml b/docs/gst/tmpl/gstbufferpool.sgml index 91ea231866..24243edbae 100644 --- a/docs/gst/tmpl/gstbufferpool.sgml +++ b/docs/gst/tmpl/gstbufferpool.sgml @@ -35,22 +35,23 @@ the number of memcpy operations. - +The function called when a buffer has to be created for this pool. -@pool: -@user_data: -@Returns: +@pool: the pool from which to create the buffer +@user_data: any user data +@Returns: a new buffer from the pool - +This function will be called when the given buffer has to be returned to +the pool. -@pool: -@buffer: -@user_data: +@pool: the pool to return the buffer to +@buffer: the buffer to return +@user_data: any user data diff --git a/docs/gst/tmpl/gstelement.sgml b/docs/gst/tmpl/gstelement.sgml index 7ec802185d..548466dee7 100644 --- a/docs/gst/tmpl/gstelement.sgml +++ b/docs/gst/tmpl/gstelement.sgml @@ -142,6 +142,7 @@ may have. @GST_ELEMENT_MULTI_IN: @GST_ELEMENT_THREAD_SUGGESTED: +@GST_ELEMENT_NO_SEEK: diff --git a/docs/gst/tmpl/gstpad.sgml b/docs/gst/tmpl/gstpad.sgml index ab7d4af19e..0916e37969 100644 --- a/docs/gst/tmpl/gstpad.sgml +++ b/docs/gst/tmpl/gstpad.sgml @@ -55,6 +55,16 @@ The function that will be called when pulling buffers. @pad: the pad to pull + + +The function that will be called when pulling a region buffer. + + +@pad: the pad to pull +@offset: the offset of the region to pull +@size: the size of the region to pull + + @@ -92,7 +102,7 @@ the function that will be called when a QoS message is sent. @Returns: - + @@ -253,6 +263,17 @@ the function that will be called when a QoS message is sent. @Returns: + + + + + +@pad: +@offset: +@size: +@Returns: + +