Documentation updates and fixes: all documented and plugin-visible API is

2009-02-07  Philip Withnall  <philip@tecnocode.co.uk>

	* configure.in:
	* docs/reference/Makefile.am:
	* docs/reference/totem-docs.sgml:
	* docs/reference/totem-docs.xml:
	* docs/reference/totem-sections.txt:
	* src/plugins/totem-plugin.c:
	* src/plugins/totem-plugin.h:
	* src/totem-cell-renderer-video.c
	(totem_cell_renderer_video_class_init):
	* src/totem-cell-renderer-video.h:
	* src/totem-interface.c:
	* src/totem-object.c (totem_object_class_init):
	* src/totem-video-list.c (totem_video_list_class_init):
	* src/totem-video-list.h:
	* src/totem.h: Documentation updates and fixes: all documented and
	plugin-visible API is now listed in the documentation, and the
	section titles/descriptions have all been updated. The documentation
	layout has been tidied up, and recent gtk-doc features have been
	taken advantage of
	(http://live.gnome.org/DocumentationProject/GtkDocGnomeGoal).


svn path=/trunk/; revision=5950

4 files changed, 104 insertions, 20 deletions

diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 1687873aa..468df3b7d 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -12,7 +12,7 @@ AUTOMAKE_OPTIONS = 1.6
 DOC_MODULE=totem
 
 # The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 
 # The directory containing the source code. Relative to $(srcdir).
 # gtk-doc will search all .c & .h files beneath here for inline comments
@@ -29,7 +29,7 @@ SCAN_OPTIONS=
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=totem
 
 # Extra options to supply to gtkdoc-mktmpl
 # e.g. MKTMPL_OPTIONS=--only-section-tmpl
@@ -48,6 +48,7 @@ CFILE_GLOB=$(top_srcdir)/src/*.c
 # Header files to ignore when scanning.
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
 IGNORE_HFILES = \
+	totem-private.h		\
 	ev-sidebar.h		\
 	eggdesktopfile.h	\
 	eggfileformatchooser.h	\
@@ -87,3 +88,5 @@ include $(top_srcdir)/gtk-doc.make
 # Other files to distribute
 # e.g. EXTRA_DIST += version.xml.in
 EXTRA_DIST += version.xml.in
+
+TESTS = $(GTKDOC_CHECK)
diff --git a/docs/reference/totem-docs.sgml b/docs/reference/totem-docs.sgml
deleted file mode 100644
index 8e72c252a..000000000
--- a/docs/reference/totem-docs.sgml
+++ /dev/null
@@ -1,18 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-	<!ENTITY version SYSTEM "version.xml">
-	<!ENTITY slash "/">
-]>
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
-	<bookinfo>
-		<title>Totem Reference Manual</title>
-		<releaseinfo>for Totem &version;</releaseinfo>
-	</bookinfo>
-	<chapter>
-		<title>API Reference</title>
-		<xi:include href="xml/totem-object.xml"/>
-		<xi:include href="xml/totem-plugin.xml"/>
-		<xi:include href="xml/totem-video-list.xml"/>
-		<xi:include href="xml/totem-cell-renderer-video.xml"/>
-	</chapter>
-</book>
diff --git a/docs/reference/totem-docs.xml b/docs/reference/totem-docs.xml
new file mode 100644
index 000000000..9eedbd142
--- /dev/null
+++ b/docs/reference/totem-docs.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+	<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+	<!ENTITY version SYSTEM "version.xml">
+	<!ENTITY slash "/">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+	<bookinfo>
+		<title>Totem Reference Manual</title>
+		<releaseinfo>
+			for Totem &version;. The latest version of this documentation can be found online at
+			<ulink role="online-location" url="http://library.gnome.org/devel/totem/">http://library.gnome.org/devel/totem/</ulink>.
+		</releaseinfo>
+	</bookinfo>
+
+	<chapter id="core-api">
+		<title>Core API</title>
+		<xi:include href="xml/totem-object.xml"/>
+		<xi:include href="xml/totem-interface.xml"/>
+		<xi:include href="xml/totem-plugin.xml"/>
+	</chapter>
+	<chapter id="widget-api">
+		<title>Widgets</title>
+		<xi:include href="xml/totem-video-list.xml"/>
+		<xi:include href="xml/totem-cell-renderer-video.xml"/>
+	</chapter>
+
+	<index id="api-index-full">
+		<title>Index of all symbols</title>
+		<xi:include href="xml/api-index-full.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>
+	</index>
+</book>
diff --git a/docs/reference/totem-sections.txt b/docs/reference/totem-sections.txt
index 6b3675faa..de90d8bd1 100644
--- a/docs/reference/totem-sections.txt
+++ b/docs/reference/totem-sections.txt
@@ -1,7 +1,48 @@
 <SECTION>
 <FILE>totem-object</FILE>
+<TITLE>TotemObject</TITLE>
 TotemObject
 TotemObjectClass
+TotemRemoteCommand
+totem_object_plugins_init
+totem_object_plugins_shutdown
+totem_file_opened
+totem_file_closed
+totem_metadata_updated
+totem_action_error
+totem_action_exit
+totem_add_to_playlist_and_play
+totem_action_play
+totem_action_play_media
+totem_action_play_media_device
+totem_action_play_pause
+totem_action_pause
+totem_action_stop
+totem_action_fullscreen
+totem_action_fullscreen_toggle
+totem_action_next
+totem_action_previous
+totem_action_seek_time
+totem_action_seek_relative
+totem_action_volume_relative
+totem_action_toggle_aspect_ratio
+totem_action_get_aspect_ratio
+totem_action_set_aspect_ratio
+totem_action_toggle_controls
+totem_action_set_scale_ratio
+totem_action_remote
+totem_is_fullscreen
+totem_is_playing
+totem_is_seekable
+totem_get_main_window
+totem_get_ui_manager
+totem_get_video_widget
+totem_get_video_widget_backend_name
+totem_get_current_mrl
+totem_get_current_time
+totem_set_current_subtitle
+totem_add_sidebar_page
+totem_remove_sidebar_page
 <SUBSECTION Standard>
 TOTEM_OBJECT
 TOTEM_IS_OBJECT
@@ -12,14 +53,29 @@ TOTEM_IS_OBJECT_CLASS
 </SECTION>
 
 <SECTION>
+<FILE>totem-interface</FILE>
+<TITLE>Interface</TITLE>
+totem_interface_error_with_link
+</SECTION>
+
+<SECTION>
 <FILE>totem-plugin</FILE>
+<TITLE>TotemPlugin</TITLE>
 TotemPlugin
 TotemPluginClass
+TotemPluginError
+totem_plugin_activate
+totem_plugin_deactivate
+totem_plugin_create_configure_dialog
+totem_plugin_is_configurable
+totem_plugin_load_interface
+totem_plugin_find_file
 <SUBSECTION Standard>
 TOTEM_PLUGIN
 TOTEM_IS_PLUGIN
 TOTEM_TYPE_PLUGIN
 totem_plugin_get_type
+TOTEM_PLUGIN_GET_CLASS
 TOTEM_PLUGIN_CLASS
 TOTEM_IS_PLUGIN_CLASS
 <SUBSECTION Private>
@@ -28,13 +84,17 @@ TotemPluginPrivate
 
 <SECTION>
 <FILE>totem-video-list</FILE>
+<TITLE>TotemVideoList</TITLE>
 TotemVideoList
 TotemVideoListClass
+totem_video_list_new
+totem_video_list_get_ui_manager
 <SUBSECTION Standard>
 TOTEM_VIDEO_LIST
 TOTEM_IS_VIDEO_LIST
 TOTEM_TYPE_VIDEO_LIST
 totem_video_list_get_type
+TOTEM_VIDEO_LIST_GET_CLASS
 TOTEM_VIDEO_LIST_CLASS
 TOTEM_IS_VIDEO_LIST_CLASS
 <SUBSECTION Private>
@@ -43,13 +103,16 @@ TotemVideoListPrivate
 
 <SECTION>
 <FILE>totem-cell-renderer-video</FILE>
+<TITLE>TotemCellRendererVideo</TITLE>
 TotemCellRendererVideo
 TotemCellRendererVideoClass
+totem_cell_renderer_video_new
 <SUBSECTION Standard>
 TOTEM_CELL_RENDERER_VIDEO
 TOTEM_IS_CELL_RENDERER_VIDEO
 TOTEM_TYPE_CELL_RENDERER_VIDEO
 totem_cell_renderer_video_get_type
+TOTEM_CELL_RENDERER_VIDEO_GET_CLASS
 TOTEM_CELL_RENDERER_VIDEO_CLASS
 TOTEM_IS_CELL_RENDERER_VIDEO_CLASS
 <SUBSECTION Private>