[Libdexter-commits] SF.net SVN: libdexter:[387] libdexter/trunk
Brought to you by:
pkovacs
Menu
▾
▴
[Libdexter-commits] SF.net SVN: libdexter:[387] libdexter/trunk
|
From: <pk...@us...> - 2011-09-15 00:02:06
|
Revision: 387
http://libdexter.svn.sourceforge.net/libdexter/?rev=387&view=rev
Author: pkovacs
Date: 2011-09-15 00:01:55 +0000 (Thu, 15 Sep 2011)
Log Message:
-----------
documentation changes
Modified Paths:
--------------
libdexter/trunk/dexterplugin/dexterplugin-service.h
libdexter/trunk/docs/reference/Makefile.am
libdexter/trunk/docs/reference/dexter/building.sgml
libdexter/trunk/docs/reference/dexter/config-example.sgml
libdexter/trunk/docs/reference/dexter/config-structure.sgml
libdexter/trunk/docs/reference/dexter/dexter-docs.sgml
libdexter/trunk/docs/reference/dexter/plugins-current.sgml
libdexter/trunk/docs/reference/dexterplugin/dexterplugin-docs.sgml
Modified: libdexter/trunk/dexterplugin/dexterplugin-service.h
===================================================================
--- libdexter/trunk/dexterplugin/dexterplugin-service.h 2011-09-14 22:07:06 UTC (rev 386)
+++ libdexter/trunk/dexterplugin/dexterplugin-service.h 2011-09-15 00:01:55 UTC (rev 387)
@@ -73,7 +73,6 @@
*
* A collection of plugin service descriptors.
*
- * These collections are typically produced by service brokers with dexter_service_broker_get_services().
**/
typedef struct _dexterplugin_service_group {
/*< public >*/
Modified: libdexter/trunk/docs/reference/Makefile.am
===================================================================
--- libdexter/trunk/docs/reference/Makefile.am 2011-09-14 22:07:06 UTC (rev 386)
+++ libdexter/trunk/docs/reference/Makefile.am 2011-09-15 00:01:55 UTC (rev 387)
@@ -19,6 +19,6 @@
# 02110-1301 USA
#
-SUBDIRS = dexter dexterplugin
+SUBDIRS = dexterplugin dexter
# vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
Modified: libdexter/trunk/docs/reference/dexter/building.sgml
===================================================================
--- libdexter/trunk/docs/reference/dexter/building.sgml 2011-09-14 22:07:06 UTC (rev 386)
+++ libdexter/trunk/docs/reference/dexter/building.sgml 2011-09-15 00:01:55 UTC (rev 387)
@@ -68,7 +68,7 @@
<itemizedlist>
<listitem>
<para>
- <ulink url="http://developer.gnome.org/doc/API/2.0/glib/index.html">GLib</ulink> is
+ <ulink url="http://developer.gnome.org/glib/stable/">GLib</ulink> is
the core library requirement. Your GLib installation must have a thread implementation,
as Libdexter uses threads extensively. GLib must also support dynamic loading of modules
("plug-ins").
Modified: libdexter/trunk/docs/reference/dexter/config-example.sgml
===================================================================
--- libdexter/trunk/docs/reference/dexter/config-example.sgml 2011-09-14 22:07:06 UTC (rev 386)
+++ libdexter/trunk/docs/reference/dexter/config-example.sgml 2011-09-15 00:01:55 UTC (rev 387)
@@ -18,8 +18,8 @@
<programlisting>
[Main]
-LoadPlugins=null;audacious;sysinfo
-AuthorizedServices=null-uuid;audacious-uuid;sysinfo-procraw-uuid
+LoadPlugins=null;sysinfo
+AuthorizedServices=null-uuid;sysinfo-procraw-uuid
ThreadPoolNumThreads=10
ThreadPoolExitWait=true
@@ -50,12 +50,10 @@
[Plugins]
null=/usr/lib/libdexter/dxt-null
-audacious=/usr/lib/libdexter/dxt-audacious
sysinfo=/usr/lib/libdexter/dxt-sysinfo
[Services]
null-uuid=fff385b0-4e80-41e5-983e-fe1be625afa3
-audacious-uuid=c18794da-087e-4db9-9da9-0563793acd25
sysinfo-procraw-uuid=ce975a10-0e52-458a-a4b9-253734760436
# Null Service
Modified: libdexter/trunk/docs/reference/dexter/config-structure.sgml
===================================================================
--- libdexter/trunk/docs/reference/dexter/config-structure.sgml 2011-09-14 22:07:06 UTC (rev 386)
+++ libdexter/trunk/docs/reference/dexter/config-structure.sgml 2011-09-15 00:01:55 UTC (rev 387)
@@ -60,7 +60,7 @@
<para>
<userinput>[IPv4 or IPv6 host, default: 127.0.0.1]</userinput> Indicates the default server
host to be used when
- <ulink url="libdexter-Servers.html#dexter-server-new">dexter_server_new()</ulink>
+ <ulink url="dexter-Servers.html#dexter-server-new">dexter_server_new()</ulink>
is called with NULL host indicated.
</para>
</listitem>
@@ -71,7 +71,7 @@
<para>
<userinput>[service name or port number, default: 3663]</userinput> Indicates the default server
service or port to be used when
- <ulink url="libdexter-Servers.html#dexter-server-new">dexter_server_new()</ulink>
+ <ulink url="dexter-Servers.html#dexter-server-new">dexter_server_new()</ulink>
is called with NULL service indicated.
</para>
</listitem>
@@ -139,7 +139,7 @@
<listitem>
<para>
<userinput>[n=0,1 or 2, default: 0]</userinput> Flag indicating server support for TLS.
- See <ulink url="libdexter-Servers.html#DexterServerTLSSupportFlag">
+ See <ulink url="dexter-Servers.html#DexterServerTLSSupportFlag">
DexterServerTLSSupportFlag</ulink>.
</para>
</listitem>
@@ -149,7 +149,7 @@
<listitem>
<para>
<userinput>[n=0,1 or 2, default: 1]</userinput> Flag indicating server requirements
- for client certificates. See <ulink url="libdexter-Servers.html#DexterServerTLSClientCertFlag">
+ for client certificates. See <ulink url="dexter-Servers.html#DexterServerTLSClientCertFlag">
DexterServerTLSClientCertFlag</ulink>.
</para>
</listitem>
@@ -205,7 +205,7 @@
<para>
<userinput>[IPv4 or IPv6 host, default: 127.0.0.1]</userinput> Indicates the default channel host
to be used when
- <ulink url="libdexter-Channels.html#dexter-channel-new">dexter_channel_new()</ulink>
+ <ulink url="dexter-Channels.html#dexter-channel-new">dexter_channel_new()</ulink>
is called with NULL host indicated.
</para>
</listitem>
@@ -216,7 +216,7 @@
<para>
<userinput>[service name or port number, default: 3663]</userinput> Indicates the default
channel service or port to be used when
- <ulink url="libdexter-Channels.html#dexter-channel-new">dexter_channel_new()</ulink>
+ <ulink url="dexter-Channels.html#dexter-channel-new">dexter_channel_new()</ulink>
is called with NULL service indicated.
</para>
</listitem>
@@ -345,7 +345,7 @@
This section is reserved for service-specific settings and/or keys that the plugin may
require to initialize itself on your platform. This is distinguished from the <emphasis>
instance initialization</emphasis> that users perform, e.g. on samplers, with
- <ulink url="libdexter-Samplers.html#dexter-sampler-initialize">dexter_sampler_initialize()</ulink>.
+ <ulink url="dexter-Samplers.html#dexter-sampler-initialize">dexter_sampler_initialize()</ulink>.
</para>
</refsect1>
</refentry>
Modified: libdexter/trunk/docs/reference/dexter/dexter-docs.sgml
===================================================================
--- libdexter/trunk/docs/reference/dexter/dexter-docs.sgml 2011-09-14 22:07:06 UTC (rev 386)
+++ libdexter/trunk/docs/reference/dexter/dexter-docs.sgml 2011-09-15 00:01:55 UTC (rev 387)
@@ -122,7 +122,7 @@
threading system; the behavior of Libdexter channels and servers, and other important items.
</para>
<para>
- The Libdexter api <ulink url="libdexter-Initialization.html#dexter-init">dexter_init()</ulink>
+ The Libdexter api <ulink url="dexter-Initialization.html#dexter-init">dexter_init()</ulink>
is used to load the desired configuration file. If none is specified, Libdexter will attempt
to use <filename>$HOME/.dexterrc</filename> and, if not found:
<filename>/etc/libdexter/dexter.conf</filename>.
Modified: libdexter/trunk/docs/reference/dexter/plugins-current.sgml
===================================================================
--- libdexter/trunk/docs/reference/dexter/plugins-current.sgml 2011-09-14 22:07:06 UTC (rev 386)
+++ libdexter/trunk/docs/reference/dexter/plugins-current.sgml 2011-09-15 00:01:55 UTC (rev 387)
@@ -35,9 +35,7 @@
<entry><userinput>fff385b0-4e80-41e5-983e-fe1be625afa3</userinput></entry>
<entry><userinput>Null Service</userinput></entry>
<entry><userinput>Reference plugin that does nothing</userinput></entry>
- <entry><userinput>
- <ulink url="http://svn.sourceforge.net/viewvc/libdexter/libdexter/trunk/plugins/">Link</ulink>
- </userinput></entry>
+ <entry><userinput>Included</userinput></entry>
</row>
<row>
<entry><userinput>dxt-sysinfo</userinput></entry>
@@ -45,7 +43,7 @@
<entry><userinput>Procraw Service</userinput></entry>
<entry><userinput>Raw information from Linux /proc</userinput></entry>
<entry><userinput>
- <ulink url="http://svn.sourceforge.net/viewvc/libdexter/plugins/">Link</ulink>
+ <ulink url="http://libdexter.svn.sourceforge.net/viewvc/libdexter/plugins/">Link</ulink>
</userinput></entry>
</row>
</tbody>
Modified: libdexter/trunk/docs/reference/dexterplugin/dexterplugin-docs.sgml
===================================================================
--- libdexter/trunk/docs/reference/dexterplugin/dexterplugin-docs.sgml 2011-09-14 22:07:06 UTC (rev 386)
+++ libdexter/trunk/docs/reference/dexterplugin/dexterplugin-docs.sgml 2011-09-15 00:01:55 UTC (rev 387)
@@ -65,9 +65,9 @@
</para>
<para>
Plugin writers need a working knowledge of the
- <ulink url="http://developer.gnome.org/doc/API/2.0/gobject/index.html">GObject</ulink> object system.
+ <ulink url="http://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html">GObject</ulink> object system.
It is recommended that you review the GObject tutorial before proceeding. Libdexter plugins are
- <ulink url="http://developer.gnome.org/doc/API/2.0/gobject/GTypeModule.html">GTypeModule</ulink>'s
+ <ulink url="http://developer.gnome.org/gobject/stable/GTypeModule.html">GTypeModule</ulink>'s
that load "on-demand" instead of staying resident forever. When a GTypeModule is first loaded
(during Libdexter initialization) it registers its GObject-based types with the GType system and then
unloads. Whenever one of its registered types is instantiated, the type module reloads automatically
@@ -86,7 +86,7 @@
<para>
Plugin writers must also provide one or more public headers with their plugins so that programmers
using Libdexter may manipulate the data that the plugin produces. Refer to the
- <ulink url="libdexterplugin-guidelines.html">Guidelines</ulink> section for information on naming
+ <ulink url="dexterplugin-guidelines.html">Guidelines</ulink> section for information on naming
conventions and locations for plugin public headers. Adhering to the guidelines is
<emphasis>highly</emphasis> recommended in order to provide programmers and end-users an
organized, consistent view of all Libdexter-packaged and third-party plugins.
@@ -129,7 +129,7 @@
<listitem><userinput>dexter_plugin_exit ()</userinput> - performs any cleanup that may be required
when the module unloads.</listitem>
<listitem><userinput>dexter_plugin_get_services ()</userinput> - returns a
- <ulink url="libdexterplugin-DexterPluginService.html#DexterPluginServiceGroup">
+ <ulink url="dexterplugin-DexterPluginService.html#DexterPluginServiceGroup">
DexterPluginServiceGroup</ulink> describing all services that this plugin registers.
</listitem>
</itemizedlist>
@@ -137,8 +137,8 @@
</listitem>
<listitem>
Each service implemented by the plugin must be a
- <ulink url="http://developer.gnome.org/doc/API/2.0/gobject/index.html">GObject</ulink> derived from
- <ulink url="DexterPluginSampler.html">DexterPluginSampler</ulink>.
+ <ulink url="http://developer.gnome.org/gobject/stable/gobject-The-Base-Object-Type.html">GObject</ulink> derived from
+ <ulink url="DexterPluginSampler.html">DexterPluginSampler</ulink>
</listitem>
<listitem>
Each service implemented by the plugin must provide an implementation of the
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
