rtsp-server: Some more doc fixups
authorEdward Hervey <bilboed@bilboed.com>
Sat, 11 Dec 2010 09:48:25 +0000 (10:48 +0100)
committerEdward Hervey <bilboed@bilboed.com>
Sat, 11 Dec 2010 09:48:25 +0000 (10:48 +0100)
gst/rtsp-server/rtsp-media-mapping.h
gst/rtsp-server/rtsp-media.c
gst/rtsp-server/rtsp-media.h
gst/rtsp-server/rtsp-sdp.c
gst/rtsp-server/rtsp-session-pool.h
gst/rtsp-server/rtsp-session.c
gst/rtsp-server/rtsp-session.h

index 07d4efa..5c3e46f 100644 (file)
@@ -56,7 +56,7 @@ struct _GstRTSPMediaMapping {
  * GstRTSPMediaMappingClass:
  * @find_media: Create or return a previously cached #GstRTSPMediaFactory object
  *        for the given url. the default implementation will use the mappings
- *        added with gst_rtsp_media_mapping_add_factory ().
+ *        added with gst_rtsp_media_mapping_add_factory().
  *
  * The class for the media mapping object.
  */
index af802e9..0d93394 100644 (file)
@@ -547,7 +547,7 @@ gst_rtsp_media_get_stream (GstRTSPMedia * media, guint idx)
 
 /**
  * gst_rtsp_media_seek:
- * @stream: a #GstRTSPMediaStream
+ * @media: a #GstRTSPMedia
  * @range: a #GstRTSPTimeRange
  *
  * Seek the pipeline to @range.
@@ -1475,7 +1475,7 @@ no_more_pads_cb (GstElement * element, GstRTSPMedia * media)
 
 /**
  * gst_rtsp_media_prepare:
- * @obj: a #GstRTSPMedia
+ * @media: a #GstRTSPMedia
  *
  * Prepare @media for streaming. This function will create the pipeline and
  * other objects to manage the streaming.
@@ -1604,7 +1604,7 @@ state_failed:
 
 /**
  * gst_rtsp_media_unprepare:
- * @obj: a #GstRTSPMedia
+ * @media: a #GstRTSPMedia
  *
  * Unprepare @media. After this call, the media should be prepared again before
  * it can be used again. If the media is set to be non-reusable, a new instance
@@ -1740,7 +1740,7 @@ remove_udp_destination (GstRTSPMedia *media, GstRTSPMediaStream *stream,
  * gst_rtsp_media_set_state:
  * @media: a #GstRTSPMedia
  * @state: the target state of the media
- * @transports: a GArray of #GstRTSPMediaTrans pointers
+ * @transports: a #GArray of #GstRTSPMediaTrans pointers
  *
  * Set the state of @media to @state and for the transports in @transports.
  *
index 211e2c0..06c299d 100644 (file)
@@ -82,7 +82,6 @@ struct _GstRTSPMediaTrans {
 
 /**
  * GstRTSPMediaStream:
- *
  * @srcpad: the srcpad of the stream
  * @payloader: the payloader of the format
  * @prepared: if the stream is prepared for streaming
@@ -185,7 +184,7 @@ typedef enum {
  * @range: the range of the media being streamed
  *
  * A class that contains the GStreamer element along with a list of
- * #GstRTSPediaStream objects that can produce data.
+ * #GstRTSPMediaStream objects that can produce data.
  *
  * This object is usually created from a #GstRTSPMediaFactory.
  */
@@ -284,7 +283,7 @@ gboolean              gst_rtsp_media_seek             (GstRTSPMedia *media, GstR
 GstFlowReturn         gst_rtsp_media_stream_rtp       (GstRTSPMediaStream *stream, GstBuffer *buffer);
 GstFlowReturn         gst_rtsp_media_stream_rtcp      (GstRTSPMediaStream *stream, GstBuffer *buffer);
 
-gboolean              gst_rtsp_media_set_state        (GstRTSPMedia *media, GstState state, GArray *trans);
+gboolean              gst_rtsp_media_set_state        (GstRTSPMedia *media, GstState state, GArray *transports);
 
 void                  gst_rtsp_media_remove_elements  (GstRTSPMedia *media);
 
index 82ed995..7f400e2 100644 (file)
@@ -22,7 +22,7 @@
 
 /**
  * gst_rtsp_sdp_from_media:
- * @sdp: a #GstSDPessage
+ * @sdp: a #GstSDPMessage
  * @info: info
  * @media: a #GstRTSPMedia
  *
index 475628c..865b16b 100644 (file)
@@ -77,7 +77,7 @@ struct _GstRTSPSessionPoolClass {
  * The function will be called when the pool must be cleaned up because one or
  * more sessions timed out.
  *
- * Returns: %FALSe if the source should be removed.
+ * Returns: %FALSE if the source should be removed.
  */
 typedef gboolean (*GstRTSPSessionPoolFunc)  (GstRTSPSessionPool *pool, gpointer user_data);
 
index f435446..7e25888 100644 (file)
@@ -178,10 +178,10 @@ gst_rtsp_session_set_property (GObject * object, guint propid,
 /**
  * gst_rtsp_session_manage_media:
  * @sess: a #GstRTSPSession
- * @url: the url for the media
- * @media: a #GstRTSPMediaObject
+ * @uri: the uri for the media
+ * @media: a #GstRTSPMedia
  *
- * Manage the media object @obj in @sess. @url will be used to retrieve this
+ * Manage the media object @obj in @sess. @uri will be used to retrieve this
  * media from the session with gst_rtsp_session_get_media().
  *
  * Ownership is taken from @media.
@@ -222,7 +222,7 @@ gst_rtsp_session_manage_media (GstRTSPSession * sess, const GstRTSPUrl * uri,
 /**
  * gst_rtsp_session_release_media:
  * @sess: a #GstRTSPSession
- * @media: a #GstRTSPMediaObject
+ * @media: a #GstRTSPMedia
  *
  * Release the managed @media in @sess, freeing the memory allocated by it.
  *
index 3eab592..cfd75c6 100644 (file)
@@ -137,7 +137,7 @@ gboolean               gst_rtsp_session_release_media        (GstRTSPSession *se
                                                               GstRTSPSessionMedia *media);
 /* get media in a session */
 GstRTSPSessionMedia *  gst_rtsp_session_get_media            (GstRTSPSession *sess,
-                                                              const GstRTSPUrl *uri);
+                                                              const GstRTSPUrl *url);
 /* control media */
 gboolean               gst_rtsp_session_media_set_state      (GstRTSPSessionMedia *media, GstState state);