diff options
| author | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-01-16 11:26:16 -0300 |
|---|---|---|
| committer | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-01-27 16:36:38 -0300 |
| commit | a87b4551a6090663a1714f263d4e20fe75eb46ca (patch) | |
| tree | 4367eb5b3027851743c464bd159abb6c7325f694 /gst/gsttracerrecord.c | |
| parent | 76f049bc49fc6fc56ca19d64749cfbe2f601c3c9 (diff) | |
Port gtk-doc comments to their equivalent markdown syntax
Modernizing our documentation and preparing a possible move to hotdoc.
This commits also adds missing @title metadatas to all SECTIONs
Diffstat (limited to 'gst/gsttracerrecord.c')
| -rw-r--r-- | gst/gsttracerrecord.c | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/gst/gsttracerrecord.c b/gst/gsttracerrecord.c index 022f1694d2..00102bdd11 100644 --- a/gst/gsttracerrecord.c +++ b/gst/gsttracerrecord.c @@ -21,6 +21,7 @@ /** * SECTION:gsttracerrecord + * @title: GstTracerRecord * @short_description: Trace log entry class * * Tracing modules will create instances of this class to announce the data they @@ -175,9 +176,7 @@ gst_tracer_record_init (GstTracerRecord * self) * pointer type values must not be NULL - the underlying serialisation can not * handle that right now. * - * <note><para> - * Please note that this is still under discussion and subject to change. - * </para></note> + * > Please note that this is still under discussion and subject to change. * * Returns: a new #GstTracerRecord */ @@ -236,9 +235,8 @@ gst_tracer_record_new (const gchar * name, const gchar * firstfield, ...) * * Right now this is using the gstreamer debug log with the level TRACE (7) and * the category "GST_TRACER". - * <note><para> - * Please note that this is still under discussion and subject to change. - * </para></note> + * + * > Please note that this is still under discussion and subject to change. */ void gst_tracer_record_log (GstTracerRecord * self, ...) |