[Kst] kdeextragear-2/kst/devel-docs

[George Staikos]

CVS commit by staikos: 

plugin docs updated


  M +14 -3     KstPlugins   1.8


--- kdeextragear-2/kst/devel-docs/KstPlugins  #1.7:1.8
@@ -130,7 +130,8 @@
 
 "symbol" would be the same as the attribute "name" of the node "modulename" in
-the XML file.  The plugin must return 0 on success, or -1 on error.  It must be
-prepared to deal with inputs that are not what it expects (empty arrays, etc).
-Just return an error if that is the case.
+the XML file.  The plugin must return 0 on success, or non-zero on error.  It
+must be prepared to deal with inputs that are not what it expects (empty arrays,
+ etc).  Just return an error if that is the case.  See below for a list of
+error codes.
 
 If you return arrays, you must set outArrayLens[] appropriately.  You must
@@ -234,4 +235,14 @@
 
 
+Error Codes
+-----------
+> 0   Custom error, you must provide a symbol const char *errorCodes(int) which
+      will be called to obtain a string representing the error.  Make these
+      strings static!
+-1    Generic error
+-2    Input error (something is wrong with the inputs)
+-3    Memory error (such as malloc failure)
+< -3  RESERVED
+
 
 Kst Extensions