[Xfce4-commits] <parole:master> Update the doc sections.
Ali Abdallah
noreply at xfce.org
Fri Nov 27 10:16:01 CET 2009
Updating branch refs/heads/master
to 00aca75cbde884158d31da76857ddf402e42ceba (commit)
from 6fc1995ba8b0a255e199f9160ef592490a7d4970 (commit)
commit 00aca75cbde884158d31da76857ddf402e42ceba
Author: Ali Abdallah <ali at ali-xfce.org>
Date: Fri Nov 27 10:12:17 2009 +0100
Update the doc sections.
configure.ac.in | 2 +-
docs/plugin-api/Parole-Plugins-docs.sgml | 9 +++-
docs/plugin-api/Parole-Plugins-sections.txt | 44 +++++++++++++-
docs/plugin-api/Parole-Plugins.types | 1 +
docs/plugin-api/tmpl/parole-debug.sgml | 68 ++++++++++++++++++++
docs/plugin-api/tmpl/parole-filters.sgml | 90 +++++++++++++++++++++++++++
docs/plugin-api/tmpl/parole-pl-parser.sgml | 80 ++++++++++++++++++++++++
docs/plugin-api/tmpl/parole.sgml | 2 +-
8 files changed, 292 insertions(+), 4 deletions(-)
diff --git a/configure.ac.in b/configure.ac.in
index 94a6319..0c01107 100644
--- a/configure.ac.in
+++ b/configure.ac.in
@@ -3,7 +3,7 @@ m4_define([parole_verinfo], [0:2:0])
m4_define([parole_version_api], [0])
m4_define([parole_version_major], [0])
m4_define([parole_version_minor], [1])
-m4_define([parole_version_micro], [96])
+m4_define([parole_version_micro], [98])
m4_define([parole_version_build], [@REVISION@])
m4_define([parole_version_tag], [])
m4_define([parole_version], [parole_version_major().parole_version_minor().parole_version_micro()ifelse(parole_version_tag(), [git], [parole_version_tag().parole_version_build()], [parole_version_tag()])])
diff --git a/docs/plugin-api/Parole-Plugins-docs.sgml b/docs/plugin-api/Parole-Plugins-docs.sgml
index 031c730..7fb9374 100644
--- a/docs/plugin-api/Parole-Plugins-docs.sgml
+++ b/docs/plugin-api/Parole-Plugins-docs.sgml
@@ -48,7 +48,7 @@
<part id="fundamentals">
<title>Fundamentals</title>
-
+ <xi:include href="xml/parole.xml"/>
</part>
<part id="API">
@@ -56,7 +56,14 @@
<xi:include href="xml/parole-provider-plugin.xml"/>
<xi:include href="xml/parole-provider-player.xml"/>
<xi:include href="xml/parole-stream.xml"/>
+ </part>
+
+ <part id="Utils">
+ <title>Parole Utilities</title>
<xi:include href="xml/parole-file.xml"/>
+ <xi:include href="xml/parole-filters.xml"/>
+ <xi:include href="xml/parole-pl-parser.xml"/>
+ <xi:include href="xml/parole-debug.xml"/>
</part>
<index id="api-index-full">
diff --git a/docs/plugin-api/Parole-Plugins-sections.txt b/docs/plugin-api/Parole-Plugins-sections.txt
index 04d24ee..f0e1f1a 100644
--- a/docs/plugin-api/Parole-Plugins-sections.txt
+++ b/docs/plugin-api/Parole-Plugins-sections.txt
@@ -13,6 +13,7 @@ parole_provider_player_pause
parole_provider_player_resume
parole_provider_player_stop
parole_provider_player_seek
+parole_provider_player_open_media_chooser
<SUBSECTION Standard>
PAROLE_PROVIDER_PLAYER
PAROLE_IS_PROVIDER_PLAYER
@@ -28,7 +29,6 @@ ParoleProviderPlugin
parole_provider_plugin_get_is_configurable
parole_provider_plugin_configure
parole_provider_plugin_set_player
-parole_provider_plugin_get_is_active
<SUBSECTION Standard>
PAROLE_PROVIDER_PLUGIN
PAROLE_IS_PROVIDER_PLUGIN
@@ -75,6 +75,18 @@ parole_plugin_container_get_type
PAROLE_ENUM_TYPE_PLUGIN_CONTAINER
parole_state_get_type
PAROLE_ENUM_TYPE_STATE
+parole_pl_format_get_type
+PAROLE_ENUM_TYPE_PL_FORMAT
+</SECTION>
+
+<SECTION>
+<FILE>parole-pl-parser</FILE>
+ParolePlFormat
+parole_pl_parser_guess_format_from_extension
+parole_pl_parser_can_parse_data
+parole_pl_parser_parse_from_file_by_extension
+parole_pl_parser_parse_all_from_file
+parole_pl_parser_save_from_files
</SECTION>
<SECTION>
@@ -83,6 +95,28 @@ PAROLE_ENUM_TYPE_STATE
<SECTION>
<FILE>parole</FILE>
+PAROLE_MAJOR_VERSION
+PAROLE_MINOR_VERSION
+PAROLE_MICRO_VERSION
+PAROLE_CHECK_VERSION
+PAROLE_DEFINE_TYPE
+PAROLE_DEFINE_TYPE_EXTENDED
+PAROLE_DEFINE_TYPE_WITH_CODE
+PAROLE_DEFINE_ABSTRACT_TYPE
+PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE
+PAROLE_IMPLEMENT_INTERFACE
+</SECTION>
+
+<SECTION>
+<FILE>parole-filters</FILE>
+ParoleFileFormat
+parole_get_supported_audio_filter
+parole_get_supported_video_filter
+parole_get_supported_media_filter
+parole_get_supported_files_filter
+parole_get_supported_playlist_filter
+parole_file_filter
+parole_file_guess_format
</SECTION>
<SECTION>
@@ -92,3 +126,11 @@ parole_marshal_VOID__OBJECT_DOUBLE
parole_marshal_VOID__OBJECT_INT
</SECTION>
+<SECTION>
+<FILE>parole-debug</FILE>
+PAROLE_DEBUG_ENUM
+PAROLE_DEBUG_ENUM_FULL
+parole_debug_enum
+parole_debug_enum_full
+</SECTION>
+
diff --git a/docs/plugin-api/Parole-Plugins.types b/docs/plugin-api/Parole-Plugins.types
index 53def75..e85dd61 100644
--- a/docs/plugin-api/Parole-Plugins.types
+++ b/docs/plugin-api/Parole-Plugins.types
@@ -1,6 +1,7 @@
parole_media_type_get_type
parole_plugin_container_get_type
parole_state_get_type
+parole_pl_format_get_type
parole_provider_player_get_type
parole_provider_plugin_get_type
parole_file_get_type
diff --git a/docs/plugin-api/tmpl/parole-debug.sgml b/docs/plugin-api/tmpl/parole-debug.sgml
new file mode 100644
index 0000000..1359a59
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-debug.sgml
@@ -0,0 +1,68 @@
+<!-- ##### SECTION Title ##### -->
+Parole Debug
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO PAROLE_DEBUG_ENUM ##### -->
+<para>
+
+</para>
+
+ at _text:
+ at _value:
+ at _type:
+
+
+<!-- ##### MACRO PAROLE_DEBUG_ENUM_FULL ##### -->
+<para>
+
+</para>
+
+ at _value:
+ at _type:
+ at ...:
+
+
+<!-- ##### FUNCTION parole_debug_enum ##### -->
+<para>
+
+</para>
+
+ at func:
+ at file:
+ at line:
+ at text:
+ at v_enum:
+ at type:
+
+
+<!-- ##### FUNCTION parole_debug_enum_full ##### -->
+<para>
+
+</para>
+
+ at func:
+ at file:
+ at line:
+ at v_enum:
+ at type:
+ at format:
+ at Varargs:
+
+
diff --git a/docs/plugin-api/tmpl/parole-filters.sgml b/docs/plugin-api/tmpl/parole-filters.sgml
new file mode 100644
index 0000000..4f3451c
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-filters.sgml
@@ -0,0 +1,90 @@
+<!-- ##### SECTION Title ##### -->
+Parole Filters
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### ENUM ParoleFileFormat ##### -->
+<para>
+
+</para>
+
+ at PAROLE_FILE_UNKNOWN:
+ at PAROLE_FILE_AUDIO:
+ at PAROLE_FILE_VIDEO:
+ at PAROLE_FILE_PLAYLIST:
+
+<!-- ##### FUNCTION parole_get_supported_audio_filter ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_get_supported_video_filter ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_get_supported_media_filter ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_get_supported_files_filter ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_get_supported_playlist_filter ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_file_filter ##### -->
+<para>
+
+</para>
+
+ at filter:
+ at file:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_file_guess_format ##### -->
+<para>
+
+</para>
+
+ at file:
+ at Returns:
+
+
diff --git a/docs/plugin-api/tmpl/parole-pl-parser.sgml b/docs/plugin-api/tmpl/parole-pl-parser.sgml
new file mode 100644
index 0000000..0255390
--- /dev/null
+++ b/docs/plugin-api/tmpl/parole-pl-parser.sgml
@@ -0,0 +1,80 @@
+<!-- ##### SECTION Title ##### -->
+Parole Playlist Parser
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### ENUM ParolePlFormat ##### -->
+<para>
+
+</para>
+
+ at PAROLE_PL_FORMAT_UNKNOWN:
+ at PAROLE_PL_FORMAT_M3U:
+ at PAROLE_PL_FORMAT_PLS:
+ at PAROLE_PL_FORMAT_ASX:
+ at PAROLE_PL_FORMAT_XSPF:
+
+<!-- ##### FUNCTION parole_pl_parser_guess_format_from_extension ##### -->
+<para>
+
+</para>
+
+ at filename:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_pl_parser_can_parse_data ##### -->
+<para>
+
+</para>
+
+ at data:
+ at len:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_pl_parser_parse_from_file_by_extension ##### -->
+<para>
+
+</para>
+
+ at filename:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_pl_parser_parse_all_from_file ##### -->
+<para>
+
+</para>
+
+ at filename:
+ at Returns:
+
+
+<!-- ##### FUNCTION parole_pl_parser_save_from_files ##### -->
+<para>
+
+</para>
+
+ at files:
+ at filename:
+ at format:
+ at Returns:
+
+
diff --git a/docs/plugin-api/tmpl/parole.sgml b/docs/plugin-api/tmpl/parole.sgml
index 529c678..c64510f 100644
--- a/docs/plugin-api/tmpl/parole.sgml
+++ b/docs/plugin-api/tmpl/parole.sgml
@@ -1,5 +1,5 @@
<!-- ##### SECTION Title ##### -->
-parole
+Parole
<!-- ##### SECTION Short_Description ##### -->
More information about the Xfce4-commits
mailing list