summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPhilip Withnall <philip.withnall@collabora.co.uk>2016-11-28 09:47:24 +0000
committerPhilip Withnall <philip.withnall@collabora.co.uk>2016-11-28 09:47:24 +0000
commit7bd39330e8b83d072945068bc88d06982eab3adc (patch)
tree1a46a1a38b839f68d54e688c629a819c37c0398e /docs
parent2f2d8efab094aa58c36d1efe226cedc2184d4b67 (diff)
downloadtotem-7bd39330e8b83d072945068bc88d06982eab3adc.tar.gz
docs: Documentation checking fixes
• Add some new symbols to sections.txt, and remove old ones • Add some missing API version indexes to the documentation • Add a few missing documentation comments • Update the list of ignored files to include new headers which are not public API https://bugzilla.gnome.org/show_bug.cgi?id=774446
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/Makefile.am14
-rw-r--r--docs/reference/totem-docs.xml12
-rw-r--r--docs/reference/totem-sections.txt42
3 files changed, 46 insertions, 22 deletions
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index d03831c29..334cccc26 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -103,7 +103,19 @@ IGNORE_HFILES = \
totem-search-entry.h \
gd-tagged-entry.h \
gd-fullscreen-filter.h \
- screenshot-filename-builder.h
+ screenshot-filename-builder.h \
+ clock.h \
+ bacon-video-spinner-actor.h \
+ bacon-video-controls-actor.h \
+ totem-time-label.h \
+ totem-selection-toolbar.h \
+ totem-main-toolbar.h \
+ totem-grilo.h \
+ icon-helpers.h \
+ bacon-time-label.h \
+ totem-gst-pixbuf-helpers.h \
+ totem-time-helpers.h \
+ $(NULL)
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/docs/reference/totem-docs.xml b/docs/reference/totem-docs.xml
index dba78fd33..941755a32 100644
--- a/docs/reference/totem-docs.xml
+++ b/docs/reference/totem-docs.xml
@@ -46,6 +46,18 @@
<title>Index of new symbols in 3.1.5</title>
<xi:include href="xml/api-index-3.1.5.xml"><xi:fallback/></xi:include>
</index>
+ <index role="3.10">
+ <title>Index of new symbols in 3.10</title>
+ <xi:include href="xml/api-index-3.10.xml"><xi:fallback/></xi:include>
+ </index>
+ <index role="3.12">
+ <title>Index of new symbols in 3.12</title>
+ <xi:include href="xml/api-index-3.12.xml"><xi:fallback/></xi:include>
+ </index>
+ <index role="3.20">
+ <title>Index of new symbols in 3.20</title>
+ <xi:include href="xml/api-index-3.20.xml"><xi:fallback/></xi:include>
+ </index>
<index id="api-index-deprecated" role="deprecated">
<title>Index of deprecated symbols</title>
<xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
diff --git a/docs/reference/totem-sections.txt b/docs/reference/totem-sections.txt
index 53e8ed9ed..4e69c9f3d 100644
--- a/docs/reference/totem-sections.txt
+++ b/docs/reference/totem-sections.txt
@@ -6,51 +6,44 @@ TotemObject
TotemRemoteCommand
TotemRemoteSetting
TOTEM_GSETTINGS_SCHEMA
-totem_object_plugins_init
-totem_object_plugins_shutdown
totem_object_show_error
totem_object_exit
-totem_object_add_to_playlist_and_play
totem_object_play
totem_object_play_pause
-totem_pause
totem_object_stop
-totem_object_set_fullscreen
-totem_object_fullscreen_toggle
totem_object_seek_next
totem_object_seek_previous
-totem_next_angle
totem_object_remote_get_setting
totem_object_remote_set_setting
totem_object_seek_time
totem_object_seek_relative
totem_object_set_volume
-totem_object_set_volume_relative
-totem_object_set_volume_toggle_mute
-totem_object_toggle_aspect_ratio
-totem_object_get_aspect_ratio
-totem_object_set_aspect_ratio
-totem_object_set_playlist_index
totem_object_remote_command
-totem_is_fullscreen
totem_object_is_playing
totem_object_is_paused
totem_object_is_seekable
totem_object_get_main_window
totem_object_get_current_mrl
totem_object_get_video_widget
-totem_get_current_time
totem_object_set_current_subtitle
totem_object_get_playlist_length
totem_object_get_playlist_pos
totem_object_get_title_at_playlist_pos
-totem_get_short_title
totem_object_get_volume
-totem_object_get_version
totem_object_get_supported_content_types
totem_object_get_supported_uri_schemes
totem_object_get_rate
totem_object_set_rate
+totem_object_add_to_playlist
+totem_object_add_to_view
+totem_object_clear_playlist
+totem_object_empty_menu_section
+totem_object_get_current_time
+totem_object_get_menu_section
+totem_object_get_short_title
+totem_object_is_fullscreen
+totem_object_next_angle
+totem_object_pause
<SUBSECTION Standard>
TOTEM_OBJECT
TOTEM_IS_OBJECT
@@ -73,7 +66,6 @@ totem_object_set_mrl_and_play
totem_object_set_mrl_with_warning
totem_show_error
totem_exit
-totem_object_fullscreen_toggle
totem_next
totem_play
totem_play_pause
@@ -84,7 +76,6 @@ totem_remote_set_setting
totem_seek_time
totem_stop
totem_set_volume
-totem_add_to_playlist_and_play
totem_get_current_mrl
totem_get_main_window
totem_get_playlist_length
@@ -97,6 +88,9 @@ totem_is_paused
totem_is_playing
totem_is_seekable
totem_set_current_subtitle
+totem_gst_playbin_get_frame
+totem_gst_tag_list_get_cover
+totem_interface_create_header_button
</SECTION>
<SECTION>
@@ -169,8 +163,6 @@ bacon_video_widget_get_position
bacon_video_widget_set_referrer
bacon_video_widget_get_rotation
bacon_video_widget_set_rotation
-bacon_video_widget_get_show_cursor
-bacon_video_widget_set_show_cursor
bacon_video_widget_get_stream_length
bacon_video_widget_get_subtitles
bacon_video_widget_get_subtitle
@@ -194,6 +186,14 @@ bacon_video_widget_is_seekable
bacon_video_widget_get_rate
bacon_video_widget_set_rate
bacon_video_widget_step
+bacon_video_widget_get_controls_object
+bacon_video_widget_get_header_controls_object
+bacon_video_widget_set_fullscreen
+bacon_video_widget_set_next_language
+bacon_video_widget_set_next_subtitle
+bacon_video_widget_show_popup
+bacon_video_widget_mark_popup_busy
+bacon_video_widget_unmark_popup_busy
<SUBSECTION Standard>
BVW_TYPE_ASPECT_RATIO
BVW_TYPE_AUDIO_OUTPUT_TYPE