From: Stefan Kost <ensonic@users.sf.net>
Date: Thu, 25 Mar 2010 20:53:20 +0000 (+0200)
Subject: dtmfdetect: reformat message docs
X-Git-Tag: 1.19.3~509^2~6027^2~54
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f8aa6ab3fee3760a35b46aa2730a6dd625c85c3c;p=platform%2Fupstream%2Fgstreamer.git

dtmfdetect: reformat message docs

Use a list like in other element docs as an untweaked docbook table look ugly.
---

diff --git a/gst/dtmf/gstdtmfdetect.c b/gst/dtmf/gstdtmfdetect.c
index cf8c058..cdf7172 100644
--- a/gst/dtmf/gstdtmfdetect.c
+++ b/gst/dtmf/gstdtmfdetect.c
@@ -26,51 +26,34 @@
  * SECTION:element-dtmfdetect
  * @short_description: Detects DTMF tones
  *
- * This element will detect DTMF tones and emit messages
+ * This element will detect DTMF tones and emit messages.
  *
- * The message is called "dtmf-event" and has the following fields
- * <informaltable>
- * <tgroup cols='4'>
- * <colspec colname='Name' />
- * <colspec colname='Type' />
- * <colspec colname='Possible values' />
- * <colspec colname='Purpose' />
- * <thead>
- * <row>
- * <entry>Name</entry>
- * <entry>GType</entry>
- * <entry>Possible values</entry>
- * <entry>Purpose</entry>
- * </row>
- * </thead>
- * <tbody>
- * <row>
- * <entry>type</entry>
- * <entry>G_TYPE_INT</entry>
- * <entry>0-1</entry>
- * <entry>The application uses this field to specify which of the two methods
- * specified in RFC 2833 to use. The value should be 0 for tones and 1 for
- * named events. Tones are specified by their frequencies and events are specied
- * by their number. This element can only take events as input. Do not confuse
- * with "method" which specified the output.
- * </entry>
- * </row>
-  * <row>
- * <entry>number</entry>
- * <entry>G_TYPE_INT</entry>
- * <entry>0-16</entry>
- * <entry>The event number.</entry>
- * </row>
- * <row>
- * <entry>method</entry>
- * <entry>G_TYPE_INT</entry>
- * <entry>2</entry>
- * <entry>This field will always been 2 (ie sound) from this element.
- * </entry>
- * </row>
- * </tbody>
- * </tgroup>
- * </informaltable>
+ * The message is called <classname>&quot;dtmf-event&quot;</classname> and has
+ * the following fields:
+ * <itemizedlist>
+ * <listitem>
+ *   <para>
+ *   gint <classname>type</classname> (0-1):
+ *   The application uses this field to specify which of the two methods
+ *   specified in RFC 2833 to use. The value should be 0 for tones and 1 for
+ *   named events. Tones are specified by their frequencies and events are
+ *   specfied by their number. This element can only take events as input.
+ *   Do not confuse with "method" which specified the output.
+ *   </para>
+ * </listitem>
+ * <listitem>
+ *   <para>
+ *   gint <classname>number</classname> (0-16):
+ *   The event number.
+ *   </para>
+ * </listitem>
+ * <listitem>
+ *   <para>
+ *   gint <classname>method</classname> (2):
+ *   This field will always been 2 (ie sound) from this element.
+ *   </para>
+ * </listitem>
+ * </itemizedlist>
  */
 
 #ifdef HAVE_CONFIG_H