docs: some docs love
authorTim-Philipp Müller <tim.muller@collabora.co.uk>
Mon, 5 Sep 2011 20:40:05 +0000 (21:40 +0100)
committerTim-Philipp Müller <tim.muller@collabora.co.uk>
Mon, 5 Sep 2011 22:28:20 +0000 (23:28 +0100)
docs/libs/Makefile.am
docs/libs/gst-plugins-base-libs-sections.txt
gst-libs/gst/audio/gstaudiodecoder.c
gst-libs/gst/audio/gstaudiodecoder.h
gst-libs/gst/audio/gstaudioencoder.h

index af2632c..ba92fc5 100644 (file)
@@ -79,7 +79,13 @@ SCANOBJ_DEPS = \
        $(top_builddir)/gst-libs/gst/pbutils/libgstpbutils-@GST_MAJORMINOR@.la
 
 # Header files to ignore when scanning.
-IGNORE_HFILES = pbutils-private.h
+IGNORE_HFILES = pbutils-private.h gsttageditingprivate.h id3v2.h \
+       kiss_fft_f32.h kiss_fft_f64.h kiss_fftr_f32.h kiss_fftr_f64.h \
+       kiss_fftr_s16.h kiss_fftr_s32.h kiss_fft_s16.h kiss_fft_s32.h \
+       _kiss_fft_guts_f32.h _kiss_fft_guts_f64.h _kiss_fft_guts_s16.h \
+       _kiss_fft_guts_s16.h _kiss_fft_guts_s32.h _kiss_fft_guts_s32.h \
+       interfaces-marshal.h pbutils-marshal.h
+
 
 # Images to copy into HTML directory.
 HTML_IMAGES =
index 8c0a8b3..5fcf91f 100644 (file)
@@ -35,6 +35,7 @@ GST_IS_APP_BUFFER
 GST_IS_APP_BUFFER_CLASS
 GST_TYPE_APP_BUFFER
 GST_TYPE_APP_STREAM_TYPE
+gst_app_stream_type_get_type
 <SUBSECTION Private>
 GstAppSrc
 GstAppSrcPrivate
@@ -154,7 +155,7 @@ gst_audio_decoder_set_plc_aware
 gst_audio_decoder_set_tolerance
 <SUBSECTION Standard>
 GST_AUDIO_DECODER
-GST_IS_AUDI_DECODER
+GST_IS_AUDIO_DECODER
 GST_TYPE_AUDIO_DECODER
 gst_audio_decoder_get_type
 GST_AUDIO_DECODER_CLASS
@@ -545,6 +546,8 @@ KISS_FFT_F64_SIN
 <INCLUDE>gst/floatcast/floatcast.h</INCLUDE>
 gst_cast_double
 gst_cast_float
+<SUBSECTION Standard>
+inline
 </SECTION>
 
 
@@ -1916,7 +1919,7 @@ GST_IS_TAG_MUX_CLASS
 GST_TAG_MUX
 GST_TAG_MUX_CLASS
 GST_TYPE_TAG_MUX
-gst_tag_demux_get_type
+gst_tag_mux_get_type
 </SECTION>
 
 <SECTION>
@@ -1933,6 +1936,7 @@ gst_tag_get_language_code_iso_639_2T
 <SECTION>
 <FILE>gsttaglicenses</FILE>
 <INCLUDE>gst/tag/tag.h</INCLUDE>
+GstTagLicenseFlags
 gst_tag_get_license_flags
 gst_tag_get_license_nick
 gst_tag_get_license_title
@@ -2156,7 +2160,7 @@ GstEncodingTargetClass
 
 <SECTION>
 <FILE>gstvideo</FILE>
-<INCLUDE>gst/video/video.h</INCLUDE>
+<INCLUDE>gst/video.h</INCLUDE>
 GST_VIDEO_BLUE_MASK_15
 GST_VIDEO_BLUE_MASK_15_INT
 GST_VIDEO_BLUE_MASK_16
@@ -2222,6 +2226,7 @@ GST_VIDEO_SIZE_RANGE
 GST_VIDEO_BUFFER_TFF
 GST_VIDEO_BUFFER_RFF
 GST_VIDEO_BUFFER_ONEFIELD
+GST_VIDEO_BUFFER_PROGRESSIVE
 GstVideoFormat
 gst_video_calculate_display_ratio
 gst_video_frame_rate
@@ -2326,6 +2331,7 @@ GstDiscovererStreamInfo
 GstDiscovererContainerInfo
 GstDiscovererAudioInfo
 GstDiscovererVideoInfo
+GstDiscovererSubtitleInfo
 gst_discoverer_stream_info_get_caps
 gst_discoverer_stream_info_get_misc
 gst_discoverer_stream_info_get_next
@@ -2367,6 +2373,7 @@ GST_DISCOVERER_CONTAINER_INFO
 GST_DISCOVERER_INFO
 GST_DISCOVERER_STREAM_INFO
 GST_DISCOVERER_VIDEO_INFO
+GST_DISCOVERER_SUBTITLE_INFO
 GST_IS_DISCOVERER
 GST_IS_DISCOVERER_INFO
 GST_IS_DISCOVERER_AUDIO_INFO
@@ -2374,6 +2381,7 @@ GST_IS_DISCOVERER_CLASS
 GST_IS_DISCOVERER_CONTAINER_INFO
 GST_IS_DISCOVERER_STREAM_INFO
 GST_IS_DISCOVERER_VIDEO_INFO
+GST_IS_DISCOVERER_SUBTITLE_INFO
 GST_TYPE_DISCOVERER
 GST_TYPE_DISCOVERER_AUDIO_INFO
 GST_TYPE_DISCOVERER_CONTAINER_INFO
@@ -2381,12 +2389,14 @@ GST_TYPE_DISCOVERER_INFO
 GST_TYPE_DISCOVERER_RESULT
 GST_TYPE_DISCOVERER_STREAM_INFO
 GST_TYPE_DISCOVERER_VIDEO_INFO
+GST_TYPE_DISCOVERER_SUBTITLE_INFO
 GstDiscovererAudioInfoClass
 GstDiscovererClass
 GstDiscovererContainerInfoClass
 GstDiscovererPrivate
 GstDiscovererStreamInfoClass
 GstDiscovererVideoInfoClass
+GstDiscovererSubtitleInfoClass
 GstDiscovererInfoClass
 gst_discoverer_audio_info_get_type
 gst_discoverer_container_info_get_type
index 24298ec..9bc2065 100644 (file)
@@ -2068,11 +2068,11 @@ gst_audio_decoder_get_delay (GstAudioDecoder * dec)
  * Since: 0.10.36
  */
 void
-gst_audio_decoder_set_max_errors (GstAudioDecoder * enc, gint num)
+gst_audio_decoder_set_max_errors (GstAudioDecoder * dec, gint num)
 {
-  g_return_if_fail (GST_IS_AUDIO_DECODER (enc));
+  g_return_if_fail (GST_IS_AUDIO_DECODER (dec));
 
-  enc->priv->ctx.max_errors = num;
+  dec->priv->ctx.max_errors = num;
 }
 
 /**
@@ -2141,8 +2141,8 @@ gst_audio_decoder_get_latency (GstAudioDecoder * dec,
 /**
  * gst_audio_decoder_get_parse_state:
  * @dec: a #GstAudioDecoder
- * @min: a pointer to storage to hold current sync state
- * @max: a pointer to storage to hold current eos state
+ * @sync: a pointer to a variable to hold the current sync state
+ * @eos: a pointer to a variable to hold the current eos state
  *
  * Return current parsing (sync and eos) state.
  *
@@ -2233,7 +2233,7 @@ gst_audio_decoder_set_min_latency (GstAudioDecoder * dec, gint64 num)
 
 /**
  * gst_audio_decoder_get_min_latency:
- * @enc: a #GstAudioDecoder
+ * @dec: a #GstAudioDecoder
  *
  * Queries decoder's latency aggregation.
  *
index 0fbb20a..894e9cc 100644 (file)
@@ -120,12 +120,12 @@ GstFlowReturn _gst_audio_decoder_error (GstAudioDecoder *dec, gint weight,
  *
  * Since: 0.10.36
  */
-#define GST_AUDIO_DECODER_ERROR(el, w, domain, code, text, debug, ret) \
+#define GST_AUDIO_DECODER_ERROR(el, weight, domain, code, text, debug, ret) \
 G_STMT_START {                                                              \
   gchar *__txt = _gst_element_error_printf text;                            \
   gchar *__dbg = _gst_element_error_printf debug;                           \
   GstAudioDecoder *dec = GST_AUDIO_DECODER (el);                   \
-  ret = _gst_audio_decoder_error (dec, w, GST_ ## domain ## _ERROR,    \
+  ret = _gst_audio_decoder_error (dec, weight, GST_ ## domain ## _ERROR,    \
       GST_ ## domain ## _ERROR_ ## code, __txt, __dbg, __FILE__,            \
       GST_FUNCTION, __LINE__);                                              \
 } G_STMT_END
@@ -244,7 +244,7 @@ gint              gst_audio_decoder_get_byte_time  (GstAudioDecoder * dec);
 
 gint              gst_audio_decoder_get_delay      (GstAudioDecoder * dec);
 
-void              gst_audio_decoder_set_max_errors (GstAudioDecoder * enc,
+void              gst_audio_decoder_set_max_errors (GstAudioDecoder * dec,
                                                    gint               num);
 
 gint              gst_audio_decoder_get_max_errors (GstAudioDecoder * dec);
index 8eb9f87..4995fa9 100644 (file)
@@ -95,7 +95,6 @@ typedef struct _GstAudioEncoderPrivate GstAudioEncoderPrivate;
 
 /**
  * GstAudioEncoder:
- * @element: the parent element.
  *
  * The opaque #GstAudioEncoder data structure.
  *