[Kst] extragear/graphics/kst/kst/extensions/js

[George Staikos]

SVN commit 418108 by staikos:

A perl script that parses the headers and pulls out inline
documentation to generate the XML used to generate the HTML
API documentation for the script bindings.


 M  +29 -2     bind_plugin.h  
 M  +1 -0      classindex.xml  
 AM            jsdocs2xml.pl  


--- trunk/extragear/graphics/kst/kst/extensions/js/bind_plugin.h #418107:418108
@@ -27,6 +27,14 @@
 
 using namespace KJSEmbed;
 
+/*
+     @class Plugin
+     @description This class represents a data plugin in Kst.  It can be
+                  instantiated to create a new instance of a plugin in the
+                  Kst data collection.
+     @collection PluginCollectoin
+ */
+
 class KstBindPlugin : public KstBinding {
   public:
     KstBindPlugin(KJS::ExecState *exec, KstPluginPtr d);
@@ -42,12 +50,31 @@
 
     // member functions
 
-    // properties
+    /* @property String tagName
+       @description A unique identifier for this data object.
+     */
     void setTagName(KJS::ExecState *exec, const KJS::Value& value);
+    KJS::Value tagName(KJS::ExecState *exec) const;
+    /* @property PluginModule tagName
+       @description The library or module that is used for data processing by
+                    this plugin object.
+     */
     void setModule(KJS::ExecState *exec, const KJS::Value& value);
-    KJS::Value tagName(KJS::ExecState *exec) const;
     KJS::Value module(KJS::ExecState *exec) const;
+    /* @property String lastError
+       @description A string containing details of the last error that
+                    occurred while running the plugin.
+       @readonly
+     */
     KJS::Value lastError(KJS::ExecState *exec) const;
+    /* @property Boolean valid
+       @description True if this plugin object is valid.  If false, there is
+                    probably an invalid setting somewhere that needs to be
+                    corrected before it can be used.  Some errors include
+                    invalid inputs or outputs, or an invalid or missing
+                    PluginModule.
+       @readonly
+     */
     KJS::Value valid(KJS::ExecState *exec) const;
 
   protected:
--- trunk/extragear/graphics/kst/kst/extensions/js/classindex.xml #418107:418108
@@ -4,6 +4,7 @@
   <class name="DataVector" file="bind_datavector"/>
   <class name="Equation" file="bind_equation"/>
   <class name="Histogram" file="bind_histogram"/>
+  <class name="Plugin" file="bind_plugin"/>
   <class name="PowerSpectrum" file="bind_powerspectrum"/>
   <class name="Vector" file="bind_vector"/>
 </classes>
** trunk/extragear/graphics/kst/kst/extensions/js/jsdocs2xml.pl #property changes
Name: svn:executable
   + *