Rev 157: Added javadoc template for NdbError. in http://bazaar.launchpad.net/~ndb-connectors/ndb-connectors/ndbjmerge

[Monty Taylor]

At http://bazaar.launchpad.net/~ndb-connectors/ndb-connectors/ndbjmerge

------------------------------------------------------------
revno: 157
revision-id: mtaylor@stripped
parent: mtaylor@stripped
committer: Monty Taylor <mtaylor@stripped>
branch nick: ndbjmerge
timestamp: Tue 2007-09-18 09:53:09 +0200
message:
  Added javadoc template for NdbError.
added:
  java/swig/                     swig-20070918075236-7qc4uq3qxzhw3m6x-1
  java/swig/NdbErrorDoc.i        ndberrordoc.i-20070918075236-7qc4uq3qxzhw3m6x-2
=== added directory 'java/swig'
=== added file 'java/swig/NdbErrorDoc.i'
--- a/java/swig/NdbErrorDoc.i	1970-01-01 00:00:00 +0000
+++ b/java/swig/NdbErrorDoc.i	2007-09-18 07:53:09 +0000
@@ -0,0 +1,26 @@
+%typemap(javaimports) NdbError "
+/**
+ * @class NdbError
+ * @brief Contains error information
+ *
+ * A NdbError consists of five parts:
+ * -# Error status         : Application impact
+ * -# Error classification : Logical error group
+ * -# Error code           : Internal error code
+ * -# Error message        : Context independent description of error 
+ * -# Error details        : Context dependent information 
+ *                           (not always available)
+ *
+ * <em>Error status</em> is usually used for programming against errors.
+ * If more detailed error control is needed, it is possible to 
+ * use the <em>error classification</em>.
+ *
+ * It is not recommended to write application programs dependent on
+ * specific <em>error codes</em>.
+ *
+ * The <em>error messages</em> and <em>error details</em> may
+ * change without notice.
+ * 
+ * It is highly unlikely the user will want to use this class from Java.
+ * The use of thrown exceptions is preferrable.
+ */"