From: Stefan Kost Date: Mon, 20 Sep 2010 18:04:48 +0000 (+0300) Subject: discoverer: fix docs X-Git-Tag: RELEASE-0.10.31~176 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=784d7be3639c9ddaff66301df8b0acb701c840dc;p=platform%2Fupstream%2Fgst-plugins-base.git 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. --- diff --git a/gst-libs/gst/pbutils/gstdiscoverer.c b/gst-libs/gst/pbutils/gstdiscoverer.c index dcd07f2..a1f0889 100644 --- a/gst-libs/gst/pbutils/gstdiscoverer.c +++ b/gst-libs/gst/pbutils/gstdiscoverer.c @@ -27,13 +27,13 @@ * * 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. * * The non-blocking mode requires a running #GMainLoop in the default * #GMainContext, where one connects to the various signals, appends the - * URIs to be processed (through @gst_discoverer_discover_uri_async) and then - * asks for the discovery to begin (through @gst_discoverer_start). + * URIs to be processed (through gst_discoverer_discover_uri_async()) and then + * asks for the discovery to begin (through gst_discoverer_start()). * * 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 * 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. */ 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 * asynchronous mode. * - * Since 0.10.31 + * Since: 0.10.31 */ void gst_discoverer_start (GstDiscoverer * discoverer) @@ -1272,15 +1272,15 @@ gst_discoverer_stop (GstDiscoverer * discoverer) * @uri: the URI to add. * * 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. * - * 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 - * uris, else FALSE + * Returns: %TRUE if the @uri was succesfully appended to the list of pending + * uris, else %FALSE * - * Since 0.10.31 + * Since: 0.10.31 */ gboolean gst_discoverer_discover_uri_async (GstDiscoverer * discoverer, @@ -1312,12 +1312,12 @@ gst_discoverer_discover_uri_async (GstDiscoverer * discoverer, * * 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 * after use. * - * Since 0.10.31 + * Since: 0.10.31 */ GstDiscovererInfo * 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 * and %NULL will be returned. * - * Since 0.10.31 + * Since: 0.10.31 */ GstDiscoverer * gst_discoverer_new (GstClockTime timeout, GError ** err) diff --git a/gst-libs/gst/pbutils/gstdiscoverer.h b/gst-libs/gst/pbutils/gstdiscoverer.h index 56d50e6..748ea82 100644 --- a/gst-libs/gst/pbutils/gstdiscoverer.h +++ b/gst-libs/gst/pbutils/gstdiscoverer.h @@ -41,8 +41,8 @@ GType gst_discoverer_stream_info_get_type (void); * Base structure for informations concerning a media stream. Depending on the @streamtype, * One can find more media-specific information in #GstDiscovererAudioInfo, * #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_unref(info) (gst_mini_object_unref((GstMiniObject*) info)) @@ -58,8 +58,8 @@ const gchar * gst_discoverer_stream_info_get_stream_type_nick(GstDisc * GstDiscovererContainerInfo: * * #GstDiscovererStreamInfo specific to container streams. - * - * Since 0.10.31 + * + * Since: 0.10.31 */ #define GST_TYPE_DISCOVERER_CONTAINER_INFO \ (gst_discoverer_container_info_get_type ()) @@ -79,8 +79,8 @@ GList *gst_discoverer_container_info_get_streams(GstDiscovererStreamInfo *info); * GstDiscovererAudioInfo: * * #GstDiscovererStreamInfo specific to audio streams. - * - * Since 0.10.31 + * + * Since: 0.10.31 */ #define GST_TYPE_DISCOVERER_AUDIO_INFO \ (gst_discoverer_audio_info_get_type ()) @@ -103,8 +103,8 @@ guint gst_discoverer_audio_info_get_max_bitrate(GstDiscovererStreamInfo* info); * GstDiscovererVideoInfo: * * #GstDiscovererStreamInfo specific to video streams. - * - * Since 0.10.31 + * + * Since: 0.10.31 */ #define GST_TYPE_DISCOVERER_VIDEO_INFO \ (gst_discoverer_video_info_get_type ()) @@ -138,8 +138,8 @@ gboolean gst_discoverer_video_info_get_is_image(GstDiscovererStreamInfo* * @GST_DISCOVERER_MISSING_PLUGINS: Some plugins are missing for full discovery * * Result values for the discovery process. - * - * Since 0.10.31 + * + * Since: 0.10.31 */ typedef enum { GST_DISCOVERER_OK = 0, @@ -155,8 +155,8 @@ typedef enum { * GstDiscovererInfo: * * Structure containing the information of a URI analyzed by #GstDiscoverer. - * - * Since 0.10.31 + * + * Since: 0.10.31 */ typedef struct _GstDiscovererInfo GstDiscovererInfo; @@ -209,8 +209,8 @@ typedef struct _GstDiscovererPrivate GstDiscovererPrivate; * GstDiscoverer: * * The #GstDiscoverer structure. - * - * Since 0.10.31 + * + * Since: 0.10.31 **/ struct _GstDiscoverer { GObject parent;