docs: more updates

This commit is contained in:
Wim Taymans 2013-07-11 12:24:33 +02:00
parent ccceb1de11
commit d357fc55af
6 changed files with 7 additions and 17 deletions

View file

@ -211,10 +211,9 @@ default_setup (GstRTSPAuth * auth, GstRTSPClientState * state)
/**
* gst_rtsp_auth_setup:
* @auth: a #GstRTSPAuth
* @client: the client
* @state: TODO
* @state: the client state
*
* Add authentication tokens to @response.
* Add authentication tokens to @response in @state.
*
* Returns: FALSE if something is wrong.
*/

View file

@ -45,7 +45,6 @@ typedef struct _GstRTSPMediaFactoryPrivate GstRTSPMediaFactoryPrivate;
/**
* GstRTSPMediaFactory:
* @parent: the parent GObject
*
* The definition and logic for constructing the pipeline for a media. The media
* can contain multiple streams like audio and video.

View file

@ -82,12 +82,12 @@ struct _GstRTSPMedia {
/**
* GstRTSPMediaClass:
* @context: the main context for dispatching messages
* @loop: the mainloop for message.
* @thread: the thread dispatching messages.
* @handle_message: handle a message
* @unprepare: the default implementation sets the pipeline's state
* to GST_STATE_NULL and removes all elements.
* @convert_range: convert a range to the given unit
* @query_position: query the current posision in the pipeline
* @query_stop: query when playback will stop
*
* The RTSP media class
*/

View file

@ -41,23 +41,18 @@ typedef struct _GstRTSPMountPointsPrivate GstRTSPMountPointsPrivate;
/**
* GstRTSPMountPoints:
* @parent: parent GObject
* @mounts: the mountpoints to mediafactory mapping
*
* Creates a #GstRTSPMediaFactory object for a given url.
*/
struct _GstRTSPMountPoints {
GObject parent;
/*< private >*/
GstRTSPMountPointsPrivate *priv;
};
/**
* GstRTSPMountPointsClass:
* @parent_class: parent GObject class
* @find_factory: Create or return a previously cached #GstRTSPMediaFactory object
* for the given url. the default implementation will use the factory
* added with gst_rtsp_mount_points_add_factory().
*
* The class for the media mounts object.
*/

View file

@ -42,9 +42,6 @@ typedef struct _GstRTSPSessionPoolPrivate GstRTSPSessionPoolPrivate;
/**
* GstRTSPSessionPool:
* @max_sessions: the maximum number of sessions.
* @lock: locking the session hashtable
* @sessions: hashtable of sessions indexed by the session id.
*
* An object that keeps track of the active sessions. This object is usually
* attached to a #GstRTSPServer object to manage the sessions in that server.

View file

@ -46,13 +46,13 @@ typedef struct _GstRTSPStreamPrivate GstRTSPStreamPrivate;
/**
* GstRTSPStream:
* @parent: the parent instance
*
* The definition of a media stream.
*/
struct _GstRTSPStream {
GObject parent;
/*< private >*/
GstRTSPStreamPrivate *priv;
};