Fix up documentation blobs SGML
authorOlivier CrĂȘte <olivier.crete@collabora.co.uk>
Fri, 20 Feb 2009 22:40:57 +0000 (17:40 -0500)
committerEdward Hervey <bilboed@bilboed.com>
Sat, 21 Feb 2009 16:48:08 +0000 (17:48 +0100)
gst/dtmf/gstdtmfsrc.c
gst/dtmf/gstdtmfsrc.h
gst/dtmf/gstrtpdtmfdepay.h
gst/dtmf/gstrtpdtmfsrc.c
gst/dtmf/gstrtpdtmfsrc.h

index 06e27d4..1ccad69 100644 (file)
  * SECTION:element-dtmfsrc
  * @short_description: Generates DTMF packets
  *
- * <refsect2>
- *
- * <para>
  * The DTMFSrc element generates DTMF (ITU-T Q.23 Specification) tone packets on request
  * from application. The application communicates the beginning and end of a
  * DTMF event using custom upstream gstreamer events. To report a DTMF event, an
  * application must send an event of type GST_EVENT_CUSTOM_UPSTREAM, having a
  * structure of name "dtmf-event" with fields set according to the following
  * table:
- * </para>
  *
- * <para>
  * <informaltable>
  * <tgroup cols='4'>
  * <colspec colname='Name' />
  * <colspec colname='Type' />
  * <colspec colname='Possible values' />
  * <colspec colname='Purpose' />
- *
  * <thead>
  * <row>
  * <entry>Name</entry>
@@ -56,7 +50,6 @@
  * <entry>Purpose</entry>
  * </row>
  * </thead>
- *
  * <tbody>
  * <row>
  * <entry>type</entry>
  * </tbody>
  * </tgroup>
  * </informaltable>
- * </para>
  *
- * <para>For example, the following code informs the pipeline (and in turn, the
+ * For example, the following code informs the pipeline (and in turn, the
  * DTMFSrc element inside the pipeline) about the start of a DTMF named
  * event '1' of volume -25 dBm0:
- * </para>
  *
- * <para>
  * <programlisting>
  * structure = gst_structure_new ("dtmf-event",
  *                    "type", G_TYPE_INT, 1,
  * event = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, structure);
  * gst_element_send_event (pipeline, event);
  * </programlisting>
- * </para>
  *
- * </refsect2>
  */
 
 #ifdef HAVE_CONFIG_H
index 73970db..1d7c5ca 100644 (file)
@@ -71,6 +71,7 @@ typedef struct _GstDTMFSrcEvent GstDTMFSrcEvent;
 
 struct _GstDTMFSrc
 {
+  /*< private >*/
   GstBaseSrc parent;
   GAsyncQueue *event_queue;
   GstDTMFSrcEvent *last_event;
index 1fb8ff7..dfbcc4a 100644 (file)
@@ -45,6 +45,7 @@ typedef struct _GstRtpDTMFDepayClass GstRtpDTMFDepayClass;
 
 struct _GstRtpDTMFDepay
 {
+  /*< private >*/
   GstBaseRTPDepayload depayload;
   double sample;
   guint32 previous_ts;
index e1d252b..fa1841d 100644 (file)
  * SECTION:element-rtpdtmfsrc
  * @short_description: Generates RTP DTMF packets
  *
- * <refsect2>
- *
- * <para>
  * The RTPDTMFSrc element generates RTP DTMF (RFC 2833) event packets on request
  * from application. The application communicates the beginning and end of a
  * DTMF event using custom upstream gstreamer events. To report a DTMF event, an
  * application must send an event of type GST_EVENT_CUSTOM_UPSTREAM, having a
  * structure of name "dtmf-event" with fields set according to the following
  * table:
- * </para>
  *
- * <para>
  * <informaltable>
  * <tgroup cols='4'>
  * <colspec colname='Name' />
  * <colspec colname='Type' />
  * <colspec colname='Possible values' />
  * <colspec colname='Purpose' />
- *
  * <thead>
  * <row>
  * <entry>Name</entry>
@@ -54,7 +48,6 @@
  * <entry>Purpose</entry>
  * </row>
  * </thead>
- *
  * <tbody>
  * <row>
  * <entry>type</entry>
  * </tbody>
  * </tgroup>
  * </informaltable>
- * </para>
  *
- * <para>For example, the following code informs the pipeline (and in turn, the
+ * For example, the following code informs the pipeline (and in turn, the
  * RTPDTMFSrc element inside the pipeline) about the start of an RTP DTMF named
  * event '1' of volume -25 dBm0:
- * </para>
  *
- * <para>
  * <programlisting>
  * structure = gst_structure_new ("dtmf-event",
  *                    "type", G_TYPE_INT, 1,
  * event = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, structure);
  * gst_element_send_event (pipeline, event);
  * </programlisting>
- * </para>
  *
- * </refsect2>
  */
 
 #ifdef HAVE_CONFIG_H
index 1b40160..b1a483a 100644 (file)
@@ -69,6 +69,7 @@ typedef struct _GstRTPDTMFSrcEvent GstRTPDTMFSrcEvent;
  */
 struct _GstRTPDTMFSrc
 {
+  /*< private >*/
   GstBaseSrc basesrc;
 
   GAsyncQueue *event_queue;