docs: more helper libraries docs fixes
authorTim-Philipp Müller <tim.muller@collabora.co.uk>
Mon, 15 Mar 2010 23:46:39 +0000 (23:46 +0000)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Tue, 16 Mar 2010 00:44:50 +0000 (00:44 +0000)
Quieten gtk-doc a bit more.

docs/libs/gst-plugins-base-libs-sections.txt
gst-libs/gst/audio/audio.h
gst-libs/gst/audio/multichannel.c
gst-libs/gst/audio/multichannel.h
gst-libs/gst/interfaces/propertyprobe.c
gst-libs/gst/interfaces/tuner.c
gst-libs/gst/pbutils/install-plugins.c
gst-libs/gst/rtp/gstrtpbuffer.c
gst-libs/gst/rtsp/gstrtsptransport.h

index add855026aa88cbad8c3feb0b7ac607f7a3e26af..ce3091762df9aa0547fd1f696c3766ba90e80fea 100644 (file)
@@ -1362,6 +1362,7 @@ gst_rtp_buffer_list_set_timestamp
 <FILE>gstrtspdefs</FILE>
 <INCLUDE>gst/rtsp/gstrtspdefs.h</INCLUDE>
 GST_RTSP_CHECK
+GstRTSPEvent
 GstRTSPResult
 GstRTSPFamily
 GstRTSPState
@@ -1386,6 +1387,7 @@ gst_rtsp_find_method
 <INCLUDE>gst/rtsp/gstrtsptransport.h</INCLUDE>
 GstRTSPTransMode
 GstRTSPProfile
+GstRTSPRange
 GstRTSPLowerTrans
 GstRTSPTransport
 gst_rtsp_transport_new
index 12a12e00295dddd248225fe2afc77495f4da4896..43bf59467872ecedaac6a0a5616158a1981de21d 100644 (file)
@@ -152,6 +152,12 @@ gboolean gst_audio_is_buffer_framed     (GstPad* pad, GstBuffer* buf);
 /* functions useful for _getcaps functions */
 /**
  * GstAudioFieldFlag:
+ * @GST_AUDIO_FIELD_RATE: add rate field to caps
+ * @GST_AUDIO_FIELD_CHANNELS: add channels field to caps
+ * @GST_AUDIO_FIELD_ENDIANNESS: add endianness field to caps
+ * @GST_AUDIO_FIELD_WIDTH: add width field to caps
+ * @GST_AUDIO_FIELD_DEPTH: add depth field to caps
+ * @GST_AUDIO_FIELD_SIGNED: add signed field to caps
  *
  * Do not use anymore.
  *
index 7b319b81c328de3adf15c68f22f1caba8ef74c75..bd26f1c2b5ffaee32027bab53f84b7f0c055ab36 100644 (file)
@@ -44,7 +44,7 @@
  *   </para></listitem>
  *   <listitem><para>Either all or none of the channel positions are %GST_AUDIO_CHANNEL_POSITION_NONE.
  *   </para></listitem>
- *   <listitem><para>%GST_AUDIO_CHANNEL_POSITION_FRONT_MONO and %GST_AUDIO_CHANNEL_POSITION_LEFT or %GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT don't appear together in the given positions.
+ *   <listitem><para>%GST_AUDIO_CHANNEL_POSITION_FRONT_MONO and %GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT or %GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT don't appear together in the given positions.
  *   </para></listitem>
  * </itemizedlist>
  *
index 75dbf29bc98cb20b83dd4c6f5c62b25b2a370c19..2d9685d629a670ffe7610ab61be9cdd54cdfffff 100644 (file)
 
 G_BEGIN_DECLS
 
+/**
+ * GstAudioChannelPosition:
+ * @GST_AUDIO_CHANNEL_POSITION_FRONT_MONO: front mono
+ * @GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT: front left
+ * @GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT: front right
+ * @GST_AUDIO_CHANNEL_POSITION_REAR_CENTER: rear center
+ * @GST_AUDIO_CHANNEL_POSITION_REAR_LEFT: rear left
+ * @GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT: rear right
+ * @GST_AUDIO_CHANNEL_POSITION_LFE: subwoofer
+ * @GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER: front center
+ * @GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER: front left of center
+ * @GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER: front right of center
+ * @GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT: side left
+ * @GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT: side right
+ * @GST_AUDIO_CHANNEL_POSITION_NONE: used for position-less channels, e.g.
+ *     from a sound card that records 1024 channels; mutually exclusive with
+ *     any other channel position
+ */
 typedef enum {
   GST_AUDIO_CHANNEL_POSITION_INVALID = -1,
 
index fb896a12a64957a6251c989af187ac2ff267b620..64d0d395ec6db794a397ef081336ef40c4a05a3a 100644 (file)
@@ -165,7 +165,7 @@ gst_property_probe_get_property (GstPropertyProbe * probe, const gchar * name)
  * @probe: the #GstPropertyProbe to check.
  * @pspec: #GParamSpec of the property.
  *
- * Runs a probe on the property specified by %pspec
+ * Runs a probe on the property specified by @pspec
  */
 void
 gst_property_probe_probe_property (GstPropertyProbe * probe,
@@ -188,7 +188,7 @@ gst_property_probe_probe_property (GstPropertyProbe * probe,
  * @probe: the #GstPropertyProbe to check.
  * @name: name of the property.
  *
- * Runs a probe on the property specified by %name.
+ * Runs a probe on the property specified by @name.
  */
 void
 gst_property_probe_probe_property_name (GstPropertyProbe * probe,
index a7ba61a8f7bacfb4471e46c6ef9ff38fa805c5f8..2684517ab33b24adcd1511051bdd3adc17da29a4 100644 (file)
@@ -338,7 +338,7 @@ gst_tuner_get_norm (GstTuner * tuner)
 
 /**
  * gst_tuner_set_frequency:
- * @tuner: The #Gsttuner (a #GstElement) that owns the given channel.
+ * @tuner: The #GstTuner (a #GstElement) that owns the given channel.
  * @channel: The #GstTunerChannel to set the frequency on.
  * @frequency: The frequency to tune in to.
  *
index 7ca19deebe4d2fbc7a3f9c890d8f64e5e6df2ce6..60a426357adf1e72f6225963ce731a3cca2c9696 100644 (file)
@@ -88,7 +88,7 @@
  * </para>
  * <para>
  * The application will then call gst_install_plugins_async(), passing a
- * #NULL-terminated array of installer detail strings, and a function that
+ * NULL-terminated array of installer detail strings, and a function that
  * should be called when the installation of the plugins has finished
  * (successfully or not). Optionally, a #GstInstallPluginsContext created
  * with gst_install_plugins_context_new() may be passed as well. This way
index b050b080fad78d9667e03cc4be19959207b1d3bc..a11bf323bb2fcfa4b23f889aac7cceaeb5456a9d 100644 (file)
@@ -178,8 +178,8 @@ gst_rtp_buffer_new_copy_data (gpointer data, guint len)
  * @pad_len: the amount of padding
  * @csrc_count: the number of CSRC entries
  *
- * Allocate a new #Gstbuffer with enough data to hold an RTP packet with @csrc_count CSRCs,
- * a payload length of @payload_len and padding of @pad_len.
+ * Allocate a new #GstBuffer with enough data to hold an RTP packet with
+ * @csrc_count CSRCs, a payload length of @payload_len and padding of @pad_len.
  * All other RTP header fields will be set to 0/FALSE.
  *
  * Returns: A newly allocated buffer that can hold an RTP packet with given
index 389abd969da34d6208ca2ecc2e965a124cdeec48..71c1c5b1a799447c4abe94958300bc9760275670 100644 (file)
@@ -94,7 +94,7 @@ typedef enum {
 } GstRTSPLowerTrans;
 
 /**
- * RTSPRange:
+ * GstRTSPRange:
  * @min: minimum value of the range
  * @max: maximum value of the range
  *