discoverer: fix docs

While the doc parser allows for certain variation, it is a good idea to not
use random characters here and there, but try to stick to the little markup
syntax there is.
This commit is contained in:
Stefan Kost 2010-09-20 21:04:48 +03:00
parent f2d522670e
commit 784d7be363
2 changed files with 27 additions and 27 deletions

View file

@ -27,13 +27,13 @@
* *
* It provides two APIs, allowing usage in blocking or non-blocking mode. * It provides two APIs, allowing usage in blocking or non-blocking mode.
* *
* The blocking mode just requires calling @gst_discoverer_discover_uri * The blocking mode just requires calling gst_discoverer_discover_uri()
* with the URI one wishes to discover. * with the URI one wishes to discover.
* *
* The non-blocking mode requires a running #GMainLoop in the default * The non-blocking mode requires a running #GMainLoop in the default
* #GMainContext, where one connects to the various signals, appends the * #GMainContext, where one connects to the various signals, appends the
* URIs to be processed (through @gst_discoverer_discover_uri_async) and then * URIs to be processed (through gst_discoverer_discover_uri_async()) and then
* asks for the discovery to begin (through @gst_discoverer_start). * asks for the discovery to begin (through gst_discoverer_start()).
* *
* All the information is returned in a #GstDiscovererInfo structure. * All the information is returned in a #GstDiscovererInfo structure.
* *
@ -181,7 +181,7 @@ gst_discoverer_class_init (GstDiscovererClass * klass)
* The duration (in nanoseconds) after which the discovery of an individual * The duration (in nanoseconds) after which the discovery of an individual
* URI will timeout. * URI will timeout.
* *
* If the discovery of a URI times out, the @GST_DISCOVERER_TIMEOUT will be * If the discovery of a URI times out, the %GST_DISCOVERER_TIMEOUT will be
* set on the result flags. * set on the result flags.
*/ */
g_object_class_install_property (gobject_class, PROP_TIMEOUT, g_object_class_install_property (gobject_class, PROP_TIMEOUT,
@ -1176,7 +1176,7 @@ beach:
* A #GMainLoop must be available for #GstDiscoverer to properly work in * A #GMainLoop must be available for #GstDiscoverer to properly work in
* asynchronous mode. * asynchronous mode.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
void void
gst_discoverer_start (GstDiscoverer * discoverer) gst_discoverer_start (GstDiscoverer * discoverer)
@ -1272,15 +1272,15 @@ gst_discoverer_stop (GstDiscoverer * discoverer)
* @uri: the URI to add. * @uri: the URI to add.
* *
* Appends the given @uri to the list of URIs to discoverer. The actual * Appends the given @uri to the list of URIs to discoverer. The actual
* discovery of the @uri will only take place if @gst_discoverer_start has * discovery of the @uri will only take place if gst_discoverer_start() has
* been called. * been called.
* *
* A copy of @uri will be done internally, the caller can safely %g_free afterwards. * A copy of @uri will be done internally, the caller can safely g_free() afterwards.
* *
* Returns: TRUE if the @uri was succesfully appended to the list of pending * Returns: %TRUE if the @uri was succesfully appended to the list of pending
* uris, else FALSE * uris, else %FALSE
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
gboolean gboolean
gst_discoverer_discover_uri_async (GstDiscoverer * discoverer, gst_discoverer_discover_uri_async (GstDiscoverer * discoverer,
@ -1312,12 +1312,12 @@ gst_discoverer_discover_uri_async (GstDiscoverer * discoverer,
* *
* Synchronously discovers the given @uri. * Synchronously discovers the given @uri.
* *
* A copy of @uri will be done internally, the caller can safely %g_free afterwards. * A copy of @uri will be done internally, the caller can safely g_free() afterwards.
* *
* Returns: (transfer none): see #GstDiscovererInfo. The caller must free this structure * Returns: (transfer none): see #GstDiscovererInfo. The caller must free this structure
* after use. * after use.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
GstDiscovererInfo * GstDiscovererInfo *
gst_discoverer_discover_uri (GstDiscoverer * discoverer, const gchar * uri, gst_discoverer_discover_uri (GstDiscoverer * discoverer, const gchar * uri,
@ -1366,7 +1366,7 @@ gst_discoverer_discover_uri (GstDiscoverer * discoverer, const gchar * uri,
* If an error happened when creating the discoverer, @err will be set accordingly * If an error happened when creating the discoverer, @err will be set accordingly
* and %NULL will be returned. * and %NULL will be returned.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
GstDiscoverer * GstDiscoverer *
gst_discoverer_new (GstClockTime timeout, GError ** err) gst_discoverer_new (GstClockTime timeout, GError ** err)

View file

@ -42,7 +42,7 @@ GType gst_discoverer_stream_info_get_type (void);
* One can find more media-specific information in #GstDiscovererAudioInfo, * One can find more media-specific information in #GstDiscovererAudioInfo,
* #GstDiscovererVideoInfo, #GstDiscovererContainerInfo. * #GstDiscovererVideoInfo, #GstDiscovererContainerInfo.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
#define gst_discoverer_stream_info_ref(info) ((GstDiscovererStreamInfo*) gst_mini_object_ref((GstMiniObject*) info)) #define gst_discoverer_stream_info_ref(info) ((GstDiscovererStreamInfo*) gst_mini_object_ref((GstMiniObject*) info))
#define gst_discoverer_stream_info_unref(info) (gst_mini_object_unref((GstMiniObject*) info)) #define gst_discoverer_stream_info_unref(info) (gst_mini_object_unref((GstMiniObject*) info))
@ -59,7 +59,7 @@ const gchar * gst_discoverer_stream_info_get_stream_type_nick(GstDisc
* *
* #GstDiscovererStreamInfo specific to container streams. * #GstDiscovererStreamInfo specific to container streams.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
#define GST_TYPE_DISCOVERER_CONTAINER_INFO \ #define GST_TYPE_DISCOVERER_CONTAINER_INFO \
(gst_discoverer_container_info_get_type ()) (gst_discoverer_container_info_get_type ())
@ -80,7 +80,7 @@ GList *gst_discoverer_container_info_get_streams(GstDiscovererStreamInfo *info);
* *
* #GstDiscovererStreamInfo specific to audio streams. * #GstDiscovererStreamInfo specific to audio streams.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
#define GST_TYPE_DISCOVERER_AUDIO_INFO \ #define GST_TYPE_DISCOVERER_AUDIO_INFO \
(gst_discoverer_audio_info_get_type ()) (gst_discoverer_audio_info_get_type ())
@ -104,7 +104,7 @@ guint gst_discoverer_audio_info_get_max_bitrate(GstDiscovererStreamInfo* info);
* *
* #GstDiscovererStreamInfo specific to video streams. * #GstDiscovererStreamInfo specific to video streams.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
#define GST_TYPE_DISCOVERER_VIDEO_INFO \ #define GST_TYPE_DISCOVERER_VIDEO_INFO \
(gst_discoverer_video_info_get_type ()) (gst_discoverer_video_info_get_type ())
@ -139,7 +139,7 @@ gboolean gst_discoverer_video_info_get_is_image(GstDiscovererStreamInfo*
* *
* Result values for the discovery process. * Result values for the discovery process.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
typedef enum { typedef enum {
GST_DISCOVERER_OK = 0, GST_DISCOVERER_OK = 0,
@ -156,7 +156,7 @@ typedef enum {
* *
* Structure containing the information of a URI analyzed by #GstDiscoverer. * Structure containing the information of a URI analyzed by #GstDiscoverer.
* *
* Since 0.10.31 * Since: 0.10.31
*/ */
typedef struct _GstDiscovererInfo GstDiscovererInfo; typedef struct _GstDiscovererInfo GstDiscovererInfo;
@ -210,7 +210,7 @@ typedef struct _GstDiscovererPrivate GstDiscovererPrivate;
* *
* The #GstDiscoverer structure. * The #GstDiscoverer structure.
* *
* Since 0.10.31 * Since: 0.10.31
**/ **/
struct _GstDiscoverer { struct _GstDiscoverer {
GObject parent; GObject parent;