Commit 10c161c7 authored by Edward Hervey's avatar Edward Hervey Committed by Edward Hervey

docs/libs: The big spring cleanup

* Explicitely specify which headers aren't to be included in gtkdoc-scan
  This is essentially all the headers that are not installed and only
  for internal/local usage. This also includes the orc-generated headers.
* Remove all symbols/sections that are no longer present (due to accurately
  scanning only the headers we need).
* Add or expose sections which weren't previously exposed
* Make sure the "unified" library headers (ex: gst/video/video.h) are used
  everywhere applicable. Only use the specific headers where applicable
  (such as the GL-implementation-specific objects)
* Add all documentation which was not previously exposed in the right sections
* Update 'types' file to get as many runtime information as possible

This brings down the number of unused symbols to 15 (from over 300).
parent 22c9e5f7
......@@ -36,15 +36,60 @@ FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html \
HFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.h
CFILE_GLOB=$(top_srcdir)/gst-libs/gst/*/*.c
KISS_FFT_HFILES=$(wildcard $(top_srcdir)/gst-libs/gst/fft/*kiss_fft*.h)
# Header files to ignore when scanning.
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 \
pbutils-marshal.h \
# Note that you can't use glob, so all headers to be ignored must be specified
IGNORE_HFILES = \
$(top_srcdir)/gst-libs/gst/gettext.h \
$(top_srcdir)/gst-libs/gst/gst-i18n-app.h \
$(top_srcdir)/gst-libs/gst/gst-i18n-plugin.h \
$(top_srcdir)/gst-libs/gst/glib-compat-private.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudioutilsprivate.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudiopack.h \
$(top_srcdir)/gst-libs/gst/audio/gstaudiopack-dist.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-private.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-macros.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse2.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-x86-sse41.h \
$(top_srcdir)/gst-libs/gst/audio/audio-resampler-neon.h \
$(top_srcdir)/gst-libs/gst/gl/gstglcontext_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglsl_private.h
$(top_srcdir)/gst-libs/gst/gl/gstglfeature_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglsl_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglutil_private.h \
$(top_srcdir)/gst-libs/gst/gl/gstglwindow_private.h \
$(top_srcdir)/gst-libs/gst/gl/android/gstglwindow_android_egl.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstglcontext_cocoa.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstglwindow_cocoa.h \
$(top_srcdir)/gst-libs/gst/gl/cocoa/gstgl_cocoa_private.h \
$(top_srcdir)/gst-libs/gst/gl/dispmanx/gstglwindow_dispmanx_egl.h \
$(top_srcdir)/gst-libs/gst/gl/eagl/gstglwindow_eagl.h \
$(top_srcdir)/gst-libs/gst/gl/eagl/gstglcontext_eagl.h \
$(top_srcdir)/gst-libs/gst/gl/egl/gstglcontext_egl.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstgl_gbm_utils.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstgldisplay_gbm.h \
$(top_srcdir)/gst-libs/gst/gl/gbm/gstglwindow_gbm_egl.h \
$(top_srcdir)/gst-libs/gst/gl/utils/opengl_versions.h \
$(top_srcdir)/gst-libs/gst/gl/utils/gles_versions.h \
$(top_srcdir)/gst-libs/gst/gl/viv-fb/gstgldisplay_viv_fb.h \
$(top_srcdir)/gst-libs/gst/gl/viv-fb/gstglwindow_viv_fb_egl.h \
$(top_srcdir)/gst-libs/gst/gl/wayland/gstglwindow_wayland_egl.h \
$(top_srcdir)/gst-libs/gst/gl/wayland/wayland_event_source.h \
$(top_srcdir)/gst-libs/gst/gl/win32/gstglcontext_wgl.h \
$(top_srcdir)/gst-libs/gst/gl/win32/gstglwindow_win32.h \
$(top_srcdir)/gst-libs/gst/gl/win32/win32_message_source.h \
$(top_srcdir)/gst-libs/gst/gl/x11/gstglwindow_x11.h \
$(top_srcdir)/gst-libs/gst/gl/x11/gstglcontext_glx.h \
$(top_srcdir)/gst-libs/gst/gl/x11/xcb_event_source.h \
$(KISS_FFT_HFILES) \
$(top_srcdir)/gst-libs/gst/pbutils/pbutils-private.h \
$(top_srcdir)/gst-libs/gst/tag/gsttageditingprivate.h \
$(top_srcdir)/gst-libs/gst/tag/id3v2.h \
$(top_srcdir)/gst-libs/gst/video/gstvideoutilsprivate.h \
$(top_srcdir)/gst-libs/gst/video/video-orc.h \
$(top_srcdir)/gst-libs/gst/video/video-orc-dist.h
# Images to copy into HTML directory.
......
......@@ -117,6 +117,7 @@
<xi:include href="xml/gstrtcpbuffer.xml" />
<xi:include href="xml/gstrtppayloads.xml" />
<xi:include href="xml/gstrtphdrext.xml" />
<xi:include href="xml/gstrtpdefs.xml" />
</chapter>
<chapter id="gstreamer-rtsp">
......@@ -190,6 +191,7 @@
<xi:include href="xml/gstpbutilsinstallplugins.xml" />
<xi:include href="xml/gstdiscoverer.xml" />
<xi:include href="xml/encoding-profile.xml" />
<xi:include href="xml/gstaudiovisualizer.xml" />
</chapter>
<chapter id="gstreamer-video">
......@@ -235,17 +237,11 @@
<xi:include href="xml/gstglcolorconvert.xml"/>
<xi:include href="xml/gstglcontext.xml"/>
<!-- Not exposed as public API
<xi:include href="xml/gstglcontextcocoa.xml"/>
<xi:include href="xml/gstglcontexteagl.xml"/>
<xi:include href="xml/gstglcontextegl.xml"/>
<xi:include href="xml/gstglcontextglx.xml"/>
<xi:include href="xml/gstglcontextwgl.xml"/>
-->
<xi:include href="xml/gstgldisplay.xml"/>
<!-- Not exposed as public API
<xi:include href="xml/gstgldisplaycocoa.xml"/>
<xi:include href="xml/gstgldisplayegl.xml"/>
-->
<xi:include href="xml/gstgldisplaywayland.xml"/>
<xi:include href="xml/gstgldisplayx11.xml"/>
<xi:include href="xml/gsteglimage.xml"/>
......@@ -264,15 +260,6 @@
<xi:include href="xml/gstglupload.xml"/>
<xi:include href="xml/gstglviewconvert.xml"/>
<xi:include href="xml/gstglwindow.xml"/>
<!-- Not exposed as public API
<xi:include href="xml/gstglwindowandroid.xml"/>
<xi:include href="xml/gstglwindowcocoa.xml"/>
<xi:include href="xml/gstglwindowdispmanx.xml"/>
<xi:include href="xml/gstglwindoweagl.xml"/>
<xi:include href="xml/gstglwindowwayland.xml"/>
<xi:include href="xml/gstglwindowwin32.xml"/>
<xi:include href="xml/gstglwindowx11.xml"/>
-->
<!-- Some utilities -->
<xi:include href="xml/gstgldebug.xml"/>
<xi:include href="xml/gstglformat.xml"/>
......
#include <gst/gst.h>
#include <gst/audio/gstaudioaggregator.h>
#include <gst/allocators/allocators.h>
gst_dmabuf_allocator_get_type
gst_fd_allocator_get_type
gst_phys_memory_allocator_get_type
#include <gst/app/app.h>
gst_app_src_get_type
gst_app_sink_get_type
gst_app_stream_type_get_type
#include <gst/audio/audio.h>
gst_audio_info_get_type
gst_audio_flags_get_type
gst_audio_format_flags_get_type
gst_audio_format_get_type
gst_audio_format_info_get_type
gst_audio_layout_get_type
gst_audio_pack_flags_get_type
gst_audio_resampler_filter_interpolation_get_type
gst_audio_resampler_filter_mode_get_type
gst_audio_resampler_flags_get_type
gst_audio_resampler_method_get_type
gst_audio_stream_align_get_type
gst_audio_aggregator_get_type
gst_audio_aggregator_pad_get_type
gst_audio_aggregator_convert_pad_get_type
#include <gst/audio/gstaudiocdsrc.h>
gst_audio_cd_src_get_type
#include <gst/audio/gstaudioclock.h>
gst_audio_clock_get_type
#include <gst/audio/gstaudiodecoder.h>
gst_audio_decoder_get_type
#include <gst/audio/gstaudioencoder.h>
gst_audio_encoder_get_type
#include <gst/audio/gstaudiofilter.h>
gst_audio_filter_get_type
#include <gst/audio/gstaudiosink.h>
gst_audio_sink_get_type
#include <gst/audio/gstaudiosrc.h>
gst_audio_src_get_type
#include <gst/audio/gstaudiobasesink.h>
gst_audio_base_sink_get_type
#include <gst/audio/gstaudiobasesrc.h>
gst_audio_base_sink_slave_method_get_type
gst_audio_base_sink_discont_reason_get_type
gst_audio_base_src_get_type
#include <gst/audio/gstaudioringbuffer.h>
gst_audio_ring_buffer_get_type
#include <gst/video/navigation.h>
gst_navigation_get_type
#include <gst/audio/streamvolume.h>
gst_stream_volume_get_type
#include <gst/rtp/gstrtpbasedepayload.h>
#include <gst/rtp/rtp.h>
gst_rtp_base_depayload_get_type
#include <gst/rtp/gstrtpbasepayload.h>
gst_rtp_base_payload_get_type
#include <gst/rtp/gstrtpbaseaudiopayload.h>
gst_rtp_base_audio_payload_get_type
#include <gst/video/gstvideofilter.h>
#include <gst/video/video.h>
gst_video_filter_get_type
#include <gst/video/gstvideosink.h>
gst_video_sink_get_type
#include <gst/video/colorbalance.h>
gst_color_balance_get_type
gst_color_balance_channel_get_type
#include <gst/video/videodirection.h>
gst_video_direction_get_type
#include <gst/video/videoorientation.h>
gst_video_orientation_get_type
#include <gst/video/videooverlay.h>
gst_video_overlay_get_type
gst_video_encoder_get_type
gst_video_decoder_get_type
gst_video_buffer_pool_get_type
gst_navigation_get_type
#include <gst/pbutils/pbutils.h>
gst_discoverer_get_type
#include <gst/pbutils/encoding-profile.h>
#include <gst/pbutils/encoding-target.h>
gst_discoverer_serialize_flags_get_type
gst_audio_visualizer_get_type
gst_encoding_profile_get_type
gst_encoding_video_profile_get_type
gst_encoding_video_profile_get_type
......@@ -88,3 +92,29 @@ gst_gl_overlay_compositor_get_type
gst_gl_upload_get_type
gst_gl_view_convert_get_type
gst_gl_window_get_type
#include <gst/gl/wayland/gstgldisplay_wayland.h>
gst_gl_display_wayland_get_type
#include <gst/rtsp/rtsp.h>
gst_rtsp_auth_method_get_type
gst_rtsp_auth_credential_get_type
gst_rtsp_event_get_type
gst_rtsp_family_get_type
gst_rtsp_header_field_get_type
gst_rtsp_lower_trans_get_type
gst_rtsp_method_get_type
gst_rtsp_msg_type_get_type
gst_rtsp_profile_get_type
gst_rtsp_range_unit_get_type
gst_rtsp_result_get_type
gst_rtsp_state_get_type
gst_rtsp_status_code_get_type
gst_rtsp_time_type_get_type
gst_rtsp_trans_mode_get_type
gst_rtsp_version_get_type
gst_rtsp_extension_get_type
gst_rtsp_auth_credential_get_type
gst_rtsp_auth_param_get_type
gst_rtsp_msg_get_type
gst_rtsp_url_get_type
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment