[Xfce4-commits] <parole:master> Update the reference guide.
Ali Abdallah
noreply at xfce.org
Thu Nov 26 10:16:04 CET 2009
Updating branch refs/heads/master
to d778ce247b3ae2c257e8962fd18d7ab13b07e290 (commit)
from 6dfca392c16a4afe1726307a59a7ee5411578c5e (commit)
commit d778ce247b3ae2c257e8962fd18d7ab13b07e290
Author: Ali Abdallah <ali at ali-xfce.org>
Date: Thu Nov 26 08:58:45 2009 +0100
Update the reference guide.
docs/plugin-api/Makefile.am | 2 +-
docs/plugin-api/Parole-Plugins-docs.sgml | 4 +-
.../Parole-Plugins-unused.sgml} | 0
docs/plugin-api/tmpl/parole-enum-types.sgml | 64 ++++++++
docs/plugin-api/tmpl/parole-file.sgml | 100 ++++++++++++
docs/plugin-api/tmpl/parole-marshal.sgml | 58 +++++++
docs/plugin-api/tmpl/parole-provider-player.sgml | 150 ++++++++++++++++++
docs/plugin-api/tmpl/parole-provider-plugin.sgml | 70 +++++++++
docs/plugin-api/tmpl/parole-stream.sgml | 160 ++++++++++++++++++++
docs/plugin-api/tmpl/parole.sgml | 19 +++
docs/plugin-api/tmpl/stamp-enum-types.sgml | 19 +++
11 files changed, 643 insertions(+), 3 deletions(-)
diff --git a/docs/plugin-api/Makefile.am b/docs/plugin-api/Makefile.am
index b19bbb8..88be230 100644
--- a/docs/plugin-api/Makefile.am
+++ b/docs/plugin-api/Makefile.am
@@ -1,6 +1,6 @@
## Process this file with automake to produce Makefile.in
-AUTOMAKE_OPTIONS = 1.7
+AUTOMAKE_OPTIONS = 1.8
# This is a blank Makefile.am for using gtk-doc.
# Copy this to your project's API docs directory and modify the variables to
diff --git a/docs/plugin-api/Parole-Plugins-docs.sgml b/docs/plugin-api/Parole-Plugins-docs.sgml
index 95ab958..031c730 100644
--- a/docs/plugin-api/Parole-Plugins-docs.sgml
+++ b/docs/plugin-api/Parole-Plugins-docs.sgml
@@ -53,10 +53,10 @@
<part id="API">
<title>Parole Plugin Reference</title>
- <xi:include href="xml/parole-provider-player.xml"/>
<xi:include href="xml/parole-provider-plugin.xml"/>
- <xi:include href="xml/parole-file.xml"/>
+ <xi:include href="xml/parole-provider-player.xml"/>
<xi:include href="xml/parole-stream.xml"/>
+ <xi:include href="xml/parole-file.xml"/>
</part>
<index id="api-index-full">
diff --git a/docs/plugin-api/Parole-Plugins-overrides.txt b/docs/plugin-api/tmpl/Parole-Plugins-unused.sgml
similarity index 100%
copy from docs/plugin-api/Parole-Plugins-overrides.txt
copy to docs/plugin-api/tmpl/Parole-Plugins-unused.sgml
diff --git a/docs/plugin-api/tmpl/parole-enum-types.sgml b/docs/plugin-api/tmpl/parole-enum-types.sgml
new file mode 100644
index 0000000..d1ebf7e
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-enum-types.sgml
@@ -0,0 +1,64 @@
+<!-- ##### SECTION Title ##### -->
+parole-enum-types
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION parole_media_type_get_type ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### MACRO PAROLE_ENUM_TYPE_MEDIA_TYPE ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION parole_plugin_container_get_type ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### MACRO PAROLE_ENUM_TYPE_PLUGIN_CONTAINER ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION parole_state_get_type ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### MACRO PAROLE_ENUM_TYPE_STATE ##### -->
+<para>
+
+</para>
+
+
+
diff --git a/docs/plugin-api/tmpl/parole-file.sgml b/docs/plugin-api/tmpl/parole-file.sgml
new file mode 100644
index 0000000..9df6242
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-file.sgml
@@ -0,0 +1,100 @@
+<!-- ##### SECTION Title ##### -->
+ParoleFile
+
+<!-- ##### SECTION Short_Description ##### -->
+Simple file handling.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT ParoleFile ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG ParoleFile:content-type ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleFile:display-name ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleFile:filename ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleFile:uri ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION parole_file_new ##### -->
+<para>
+
+</para>
+
+ at filename:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_file_new_with_display_name ##### -->
+<para>
+
+</para>
+
+ at filename:
+ at display_name:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_file_get_file_name ##### -->
+<para>
+
+</para>
+
+ at file:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_file_get_display_name ##### -->
+<para>
+
+</para>
+
+ at file:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_file_get_uri ##### -->
+<para>
+
+</para>
+
+ at file:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_file_get_content_type ##### -->
+<para>
+
+</para>
+
+ at file:
+ at Returns:
+
+
diff --git a/docs/plugin-api/tmpl/parole-marshal.sgml b/docs/plugin-api/tmpl/parole-marshal.sgml
new file mode 100644
index 0000000..4eb6295
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-marshal.sgml
@@ -0,0 +1,58 @@
+<!-- ##### SECTION Title ##### -->
+parole-marshal
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION parole_marshal_VOID__OBJECT_ENUM ##### -->
+<para>
+
+</para>
+
+ at closure:
+ at return_value:
+ at n_param_values:
+ at param_values:
+ at invocation_hint:
+ at marshal_data:
+
+
+<!-- ##### FUNCTION parole_marshal_VOID__OBJECT_DOUBLE ##### -->
+<para>
+
+</para>
+
+ at closure:
+ at return_value:
+ at n_param_values:
+ at param_values:
+ at invocation_hint:
+ at marshal_data:
+
+
+<!-- ##### FUNCTION parole_marshal_VOID__OBJECT_INT ##### -->
+<para>
+
+</para>
+
+ at closure:
+ at return_value:
+ at n_param_values:
+ at param_values:
+ at invocation_hint:
+ at marshal_data:
+
+
diff --git a/docs/plugin-api/tmpl/parole-provider-player.sgml b/docs/plugin-api/tmpl/parole-provider-player.sgml
new file mode 100644
index 0000000..eb581fa
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-provider-player.sgml
@@ -0,0 +1,150 @@
+<!-- ##### SECTION Title ##### -->
+ParoleProviderPlayer
+
+<!-- ##### SECTION Short_Description ##### -->
+The interface of the player.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO PAROLE_PROVIDER_PLAYER_GET_INTERFACE ##### -->
+<para>
+
+</para>
+
+ at o:
+
+
+<!-- ##### STRUCT ParoleProviderPlayerIface ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SIGNAL ParoleProviderPlayerIface::state-changed ##### -->
+<para>
+
+</para>
+
+ at paroleproviderplayeriface: the object which received the signal.
+ at arg1:
+ at arg2:
+
+<!-- ##### SIGNAL ParoleProviderPlayerIface::tag-message ##### -->
+<para>
+
+</para>
+
+ at paroleproviderplayeriface: the object which received the signal.
+ at arg1:
+
+<!-- ##### STRUCT ParoleProviderPlayer ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ENUM ParolePluginContainer ##### -->
+<para>
+
+</para>
+
+ at PAROLE_PLUGIN_CONTAINER_PLAYLIST:
+ at PAROLE_PLUGIN_CONTAINER_MAIN_VIEW:
+
+<!-- ##### ENUM ParoleState ##### -->
+<para>
+
+</para>
+
+ at PAROLE_STATE_STOPPED:
+ at PAROLE_STATE_PLAYBACK_FINISHED:
+ at PAROLE_STATE_PAUSED:
+ at PAROLE_STATE_PLAYING:
+
+<!-- ##### FUNCTION parole_provider_player_get_main_window ##### -->
+<para>
+
+</para>
+
+ at player:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_provider_player_pack ##### -->
+<para>
+
+</para>
+
+ at player:
+ at widget:
+ at title:
+ at container:
+
+
+<!-- ##### FUNCTION parole_provider_player_get_state ##### -->
+<para>
+
+</para>
+
+ at player:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_provider_player_play_uri ##### -->
+<para>
+
+</para>
+
+ at player:
+ at uri:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_provider_player_pause ##### -->
+<para>
+
+</para>
+
+ at player:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_provider_player_resume ##### -->
+<para>
+
+</para>
+
+ at player:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_provider_player_stop ##### -->
+<para>
+
+</para>
+
+ at player:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_provider_player_seek ##### -->
+<para>
+
+</para>
+
+ at player:
+ at pos:
+ at Returns:
+
+
diff --git a/docs/plugin-api/tmpl/parole-provider-plugin.sgml b/docs/plugin-api/tmpl/parole-provider-plugin.sgml
new file mode 100644
index 0000000..e06000a
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-provider-plugin.sgml
@@ -0,0 +1,70 @@
+<!-- ##### SECTION Title ##### -->
+ParoleProviderPlugin
+
+<!-- ##### SECTION Short_Description ##### -->
+The interface of the plugin type registration.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO PAROLE_PROVIDER_PLUGIN_GET_INTERFACE ##### -->
+<para>
+
+</para>
+
+ at o:
+
+
+<!-- ##### STRUCT ParoleProviderPluginIface ##### -->
+<para>
+
+</para>
+
+ at __parent__:
+ at get_is_configurable:
+ at configure:
+ at set_player:
+
+<!-- ##### STRUCT ParoleProviderPlugin ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION parole_provider_plugin_get_is_configurable ##### -->
+<para>
+
+</para>
+
+ at provider:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_provider_plugin_configure ##### -->
+<para>
+
+</para>
+
+ at provider:
+ at parent:
+
+
+<!-- ##### FUNCTION parole_provider_plugin_set_player ##### -->
+<para>
+
+</para>
+
+ at provider:
+ at player:
+
+
diff --git a/docs/plugin-api/tmpl/parole-stream.sgml b/docs/plugin-api/tmpl/parole-stream.sgml
new file mode 100644
index 0000000..eea567a
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-stream.sgml
@@ -0,0 +1,160 @@
+<!-- ##### SECTION Title ##### -->
+ParoleStream
+
+<!-- ##### SECTION Short_Description ##### -->
+Currently playing stream.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### ENUM ParoleMediaType ##### -->
+<para>
+
+</para>
+
+ at PAROLE_MEDIA_TYPE_UNKNOWN:
+ at PAROLE_MEDIA_TYPE_LOCAL_FILE:
+ at PAROLE_MEDIA_TYPE_CDDA:
+ at PAROLE_MEDIA_TYPE_VCD:
+ at PAROLE_MEDIA_TYPE_SVCD:
+ at PAROLE_MEDIA_TYPE_DVD:
+ at PAROLE_MEDIA_TYPE_DVB:
+ at PAROLE_MEDIA_TYPE_REMOTE:
+
+<!-- ##### STRUCT ParoleStream ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### ARG ParoleStream:absolute-duration ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:album ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:artist ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:comment ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:disp-par-d ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:disp-par-n ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:duration ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:has-audio ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:has-video ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:live ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:media-type ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:num-tracks ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:seekable ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:subtitles ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:tag-available ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:title ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:track ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:uri ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:video-height ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:video-width ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG ParoleStream:year ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION parole_stream_new ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_stream_init_properties ##### -->
+<para>
+
+</para>
+
+ at stream:
+
+
diff --git a/docs/plugin-api/tmpl/parole.sgml b/docs/plugin-api/tmpl/parole.sgml
new file mode 100644
index 0000000..529c678
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole.sgml
@@ -0,0 +1,19 @@
+<!-- ##### SECTION Title ##### -->
+parole
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
diff --git a/docs/plugin-api/tmpl/stamp-enum-types.sgml b/docs/plugin-api/tmpl/stamp-enum-types.sgml
new file mode 100644
index 0000000..1d108b9
--- /dev/null
+++ b/docs/plugin-api/tmpl/stamp-enum-types.sgml
@@ -0,0 +1,19 @@
+<!-- ##### SECTION Title ##### -->
+stamp-enum-types
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
More information about the Xfce4-commits
mailing list