[Xfce4-commits] <parole:master> Update the api doc for the type macros.
Ali Abdallah
noreply at xfce.org
Mon Nov 30 11:22:05 CET 2009
Updating branch refs/heads/master
to c48f145576d9cf92b8ea267b6ea948680b22ccc9 (commit)
from 2ead12bf126875a0f476ca4298c8baef9dc70af2 (commit)
commit c48f145576d9cf92b8ea267b6ea948680b22ccc9
Author: Ali Abdallah <aliov at xfce.org>
Date: Mon Nov 30 11:20:08 2009 +0100
Update the api doc for the type macros.
docs/plugin-api/tmpl/parole-debug.sgml | 2 -
docs/plugin-api/tmpl/parole-enum-types.sgml | 15 ++++
docs/plugin-api/tmpl/parole-filters.sgml | 2 -
docs/plugin-api/tmpl/parole-pl-parser.sgml | 2 -
docs/plugin-api/tmpl/parole-provider-player.sgml | 8 ++
docs/plugin-api/tmpl/parole.sgml | 94 ++++++++++++++++++++++
parole/parole.h.in | 65 +++++++++++++++-
7 files changed, 181 insertions(+), 7 deletions(-)
diff --git a/docs/plugin-api/tmpl/parole-debug.sgml b/docs/plugin-api/tmpl/parole-debug.sgml
index 1359a59..efca9e3 100644
--- a/docs/plugin-api/tmpl/parole-debug.sgml
+++ b/docs/plugin-api/tmpl/parole-debug.sgml
@@ -9,13 +9,11 @@ Parole Debug
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/docs/plugin-api/tmpl/parole-enum-types.sgml b/docs/plugin-api/tmpl/parole-enum-types.sgml
index d1ebf7e..3e75993 100644
--- a/docs/plugin-api/tmpl/parole-enum-types.sgml
+++ b/docs/plugin-api/tmpl/parole-enum-types.sgml
@@ -62,3 +62,18 @@ parole-enum-types
+<!-- ##### FUNCTION parole_pl_format_get_type ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
+
+<!-- ##### MACRO PAROLE_ENUM_TYPE_PL_FORMAT ##### -->
+<para>
+
+</para>
+
+
+
diff --git a/docs/plugin-api/tmpl/parole-filters.sgml b/docs/plugin-api/tmpl/parole-filters.sgml
index 4f3451c..b4f9d01 100644
--- a/docs/plugin-api/tmpl/parole-filters.sgml
+++ b/docs/plugin-api/tmpl/parole-filters.sgml
@@ -9,13 +9,11 @@ Parole Filters
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/docs/plugin-api/tmpl/parole-pl-parser.sgml b/docs/plugin-api/tmpl/parole-pl-parser.sgml
index 0255390..2295761 100644
--- a/docs/plugin-api/tmpl/parole-pl-parser.sgml
+++ b/docs/plugin-api/tmpl/parole-pl-parser.sgml
@@ -9,13 +9,11 @@ Parole Playlist Parser
</para>
-
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
-
<!-- ##### SECTION Stability_Level ##### -->
diff --git a/docs/plugin-api/tmpl/parole-provider-player.sgml b/docs/plugin-api/tmpl/parole-provider-player.sgml
index eb581fa..37badd1 100644
--- a/docs/plugin-api/tmpl/parole-provider-player.sgml
+++ b/docs/plugin-api/tmpl/parole-provider-player.sgml
@@ -148,3 +148,11 @@ The interface of the player.
@Returns:
+<!-- ##### FUNCTION parole_provider_player_open_media_chooser ##### -->
+<para>
+
+</para>
+
+ at player:
+
+
diff --git a/docs/plugin-api/tmpl/parole.sgml b/docs/plugin-api/tmpl/parole.sgml
index c64510f..ffc1863 100644
--- a/docs/plugin-api/tmpl/parole.sgml
+++ b/docs/plugin-api/tmpl/parole.sgml
@@ -17,3 +17,97 @@ Parole
<!-- ##### SECTION Stability_Level ##### -->
+<!-- ##### MACRO PAROLE_MAJOR_VERSION ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO PAROLE_MINOR_VERSION ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO PAROLE_MICRO_VERSION ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### MACRO PAROLE_CHECK_VERSION ##### -->
+<para>
+
+</para>
+
+ at major:
+ at minor:
+ at micro:
+
+
+<!-- ##### MACRO PAROLE_DEFINE_TYPE ##### -->
+<para>
+
+</para>
+
+ at TN:
+ at t_n:
+ at T_P:
+
+
+<!-- ##### MACRO PAROLE_DEFINE_TYPE_EXTENDED ##### -->
+<para>
+
+</para>
+
+ at TN:
+ at t_n:
+ at T_P:
+ at _f_:
+ at _C_:
+
+
+<!-- ##### MACRO PAROLE_DEFINE_TYPE_WITH_CODE ##### -->
+<para>
+
+</para>
+
+ at TN:
+ at t_n:
+ at T_P:
+ at _C_:
+
+
+<!-- ##### MACRO PAROLE_DEFINE_ABSTRACT_TYPE ##### -->
+<para>
+
+</para>
+
+ at TN:
+ at t_n:
+ at T_P:
+
+
+<!-- ##### MACRO PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE ##### -->
+<para>
+
+</para>
+
+ at TN:
+ at t_n:
+ at T_P:
+ at _C_:
+
+
+<!-- ##### MACRO PAROLE_IMPLEMENT_INTERFACE ##### -->
+<para>
+
+</para>
+
+ at TYPE_IFACE:
+ at iface_init:
+
+
diff --git a/parole/parole.h.in b/parole/parole.h.in
index a84dcfe..a4f5a8c 100644
--- a/parole/parole.h.in
+++ b/parole/parole.h.in
@@ -37,6 +37,16 @@
#define PAROLE_MINOR_VERSION @PAROLE_VERSION_MINOR@
#define PAROLE_MICRO_VERSION @PAROLE_VERSION_MICRO@
+/**
+ * PAROLE_CHECK_VERSION:
+ * @major: major version number.
+ * @minor: minor version number.
+ * @micro: micor version number.
+ *
+ * Checks the parole version.
+ *
+ * Since: 0.2
+ */
#define PAROLE_CHECK_VERSION(major,minor,micro) \
(PAROLE_MAJOR_VERSION > (major) || \
(PAROLE_MAJOR_VERSION == (major) && PAROLE_MINOR_VERSION > (minor)) || \
@@ -46,11 +56,59 @@
/*
* GType module registration macros.
*/
+/**
+ * PAROLE_DEFINE_TYPE:
+ * @TN: The name of the new type, in Camel case.
+ * @t_n: The name of the new type, in lowercase, with words separated by '_'.
+ * @T_P: The #GType of the parent type.
+ *
+ * Since: 0.2
+ */
#define PAROLE_DEFINE_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
+
+/**
+ * PAROLE_DEFINE_TYPE_EXTENDED:
+ * @TN: The name of the new type, in Camel case.
+ * @t_n: The name of the new type, in lowercase, with words separated by '_'.
+ * @T_P: The #GType of the parent type.
+ * @_f_: #GTypeFlags to pass to g_type_module_register_type ().
+ * @_C_: Custom code that gets inserted in *_get_type() function.
+ *
+ * Since: 0.2
+ */
#define PAROLE_DEFINE_TYPE_EXTENDED(TN, t_n, T_P, _f_, _C_) _PAROLE_DEFINE_TYPE_EXTENDED_BEGIN(TN, t_n, T_P, _f_) {_C_;} _PAROLE_DEFINE_TYPE_EXTENDED_END()
+
+/**
+ * PAROLE_DEFINE_TYPE_WITH_CODE:
+ * @TN: The name of the new type, in Camel case.
+ * @t_n: The name of the new type, in lowercase, with words separated by '_'.
+ * @T_P: The #GType of the parent type.
+ * @_C_: Custom code that gets inserted in *_get_type() function.
+ *
+ * Since: 0.2
+ */
#define PAROLE_DEFINE_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _PAROLE_DEFINE_TYPE_EXTENDED_BEGIN(TN, t_n, T_P, 0) {_C_;} _PAROLE_DEFINE_TYPE_EXTENDED_END()
+
+/**
+ * PAROLE_DEFINE_ABSTRACT_TYPE:
+ * @TN: The name of the new type, in Camel case.
+ * @t_n: The name of the new type, in lowercase, with words separated by '_'.
+ * @T_P: The #GType of the parent type.
+ *
+ * Since: 0.2
+ */
#define PAROLE_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
-#define PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE(TN, t_n, T_P) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, _C_)
+
+/**
+ * PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE:
+ * @TN: The name of the new type, in Camel case.
+ * @t_n: The name of the new type, in lowercase, with words separated by '_'.
+ * @T_P: The #GType of the parent type.
+ * @_C_: Custom code that gets inserted in *_get_type() function.
+ *
+ * Since: 0.2
+ */
+#define PAROLE_DEFINE_ABSTRACT_TYPE_WITH_CODE(TN, t_n, T_P, _C_) PAROLE_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, _C_)
#define _PAROLE_DEFINE_TYPE_EXTENDED_BEGIN(TypeName, type_name, TYPE_PARENT, flags) \
@@ -104,6 +162,11 @@ type_name##_register_type (ParoleProviderPlugin *provider_plugin_def) \
} \
}
+/**
+ * PAROLE_IMPLEMENT_INTERFACE:
+ * @TYPE_IFACE: the #GType of the interface to add.
+ * @iface_init: The interface init function.
+ */
#define PAROLE_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) \
{ \
static const GInterfaceInfo parole_implement_interface_info = \
More information about the Xfce4-commits
mailing list