[ jEdit-commits ] SF.net SVN: jedit:[21613] jEdit/trunk/doc/users-guide/plugin-implement.xml

[<ez...@us...>]

Revision: 21613
          http://jedit.svn.sourceforge.net/jedit/?rev=21613&view=rev
Author:   ezust
Date:     2012-04-28 21:18:30 +0000 (Sat, 28 Apr 2012)
Log Message:
-----------
Adding a little more explanation of how to define a service. 

Modified Paths:
--------------
    jEdit/trunk/doc/users-guide/plugin-implement.xml

Modified: jEdit/trunk/doc/users-guide/plugin-implement.xml
===================================================================
--- jEdit/trunk/doc/users-guide/plugin-implement.xml	2012-04-28 16:49:03 UTC (rev 21612)
+++ jEdit/trunk/doc/users-guide/plugin-implement.xml	2012-04-28 21:18:30 UTC (rev 21613)
@@ -717,12 +717,18 @@
 </programlisting>
         </informalexample>
 
-        <para>The object it returns tells Sidekick how it can parse files of a
-        specific type. The API docs for SideKickParser indicate exactly which
-        methods must be implemented in a plugin which offers this service. It
-        should be enough information to let Sidekick, which has its own
-        dockable, display the tree information in its own view.</para>
+        <para> The value of the <literal>CLASS=</literal> should be a
+        base-class or interface of the object that is returned by
+        executing the beanshell factory method enclosed in the
+        <literal>&lt;SERVICE&gt;</literal> tag.
+        </para>
 
+        <para>In the case above, the returned object
+        tells Sidekick how it can parse files of a
+        specific type. The API docs for <literal>SideKickParser</literal>
+        should indicate precisely which methods must be implemented in a plugin
+        which offers this service. </para>
+
         <para>For more information about services, refer to the <ulink
         url="../api/org/gjt/sp/jedit/ServiceManager.html">ServiceManager</ulink>
         class API documentation. There, you can find out what the tags and

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.