docs: various doc fixes
authorStefan Kost <ensonic@users.sf.net>
Wed, 25 Feb 2009 09:45:05 +0000 (11:45 +0200)
committerStefan Kost <ensonic@users.sf.net>
Wed, 25 Feb 2009 10:42:36 +0000 (12:42 +0200)
No short-desc as we have them in the element details.
Also keep things (Makefile.am and sections.txt) sorted.
Reword ambigous returns. No text after since please.

gst/dtmf/gstdtmfsrc.c
gst/dtmf/gstdtmfsrc.h
gst/dtmf/gstrtpdtmfdepay.c
gst/dtmf/gstrtpdtmfsrc.c

index 8c5485b..8595adf 100644 (file)
@@ -27,7 +27,6 @@
 
 /**
  * SECTION:element-dtmfsrc
- * @short_description: Generates DTMF packets
  * @see_also: rtpdtmsrc, rtpdtmfmuxx
  *
  * The DTMFSrc element generates DTMF (ITU-T Q.23 Specification) tone packets on request
index 1d7c5ca..aa5d35a 100644 (file)
@@ -42,13 +42,6 @@ G_BEGIN_DECLS
 typedef struct _GstDTMFSrc GstDTMFSrc;
 typedef struct _GstDTMFSrcClass GstDTMFSrcClass;
 
-/**
- * GstDTMFSrc:
- * @element: the parent element.
- *
- * The opaque #GstDTMFSrc data structure.
- */
-
 enum _GstDTMFEventType
 {
   DTMF_EVENT_TYPE_START,
@@ -69,6 +62,12 @@ struct _GstDTMFSrcEvent
 
 typedef struct _GstDTMFSrcEvent GstDTMFSrcEvent;
 
+/**
+ * GstDTMFSrc:
+ * @element: the parent element.
+ *
+ * The opaque #GstDTMFSrc data structure.
+ */
 struct _GstDTMFSrc
 {
   /*< private >*/
index 237792b..85e7d1c 100644 (file)
@@ -21,7 +21,6 @@
  */
 /**
  * SECTION:element-rtpdtmfdepay
- * @short_description: Transforms RFC 4733/2833 RTP dtmf packets into sound
  * @see_also: rtpdtmfsrc, rtpdtmfmux
  *
  * This element takes RTP DTMF packets and produces sound. It also emits a
index 3efa460..738be59 100644 (file)
@@ -25,7 +25,6 @@
 
 /**
  * SECTION:element-rtpdtmfsrc
- * @short_description: Generates RTP DTMF packets
  * @see_also: dtmfsrc, rtpdtmfdepay, rtpdtmfmux
  *
  * The RTPDTMFSrc element generates RTP DTMF (RFC 2833) event packets on request