diff --git a/xflaim/java/xflaim/DOMNode.java b/xflaim/java/xflaim/DOMNode.java index 766289a..af0e6b8 100644 --- a/xflaim/java/xflaim/DOMNode.java +++ b/xflaim/java/xflaim/DOMNode.java @@ -1128,14 +1128,14 @@ public class DOMNode /** * Retrieves the first instance of the specified type of node from the * current node's list of child nodes. - * @param eNodeType The value representing the node type. - * (Use the constants in FlmDomNodeType.) - * @param ReusedNode An instance of DOMNode which is no longer needed and - * can be reassigned to point to different data in the database. (Reusing - * DOMNode objects is encouraged as it saves the system from allocating - * and freeing memory for each object.) Can be null, if no instances are - * available to be reused. - * @return Returns an instance of DOMNode; + * @param iNodeType The value representing the node type. + * (Use the constants in {@link xflaim.FlmDomNodeType FlmDomNodeType}.) + * @param ReusedNode An instance of {@link xflaim.DOMNode DOMNode} which is + * no longer needed and can be reassigned to point to different data in the + * database. (Reusing {@link xflaim.DOMNode DOMNode} objects is encouraged + * as it saves the system from allocating and freeing memory for each + * object.) Can be null, if no instances are available to be reused. + * @return Returns an instance of {@link xflaim.DOMNode DOMNode} * @throws XFlaimException */ public DOMNode getChild( diff --git a/xflaim/java/xflaim/DataVector.java b/xflaim/java/xflaim/DataVector.java index 7d11cf1..ae99875 100644 --- a/xflaim/java/xflaim/DataVector.java +++ b/xflaim/java/xflaim/DataVector.java @@ -37,7 +37,6 @@ public class DataVector * IF_DataVector interace are accessible through this Java object. * * @param lRef A reference to a C++ IF_DataVector object - * @param dbSystem A reference to a DbSystem object */ public DataVector( long lRef) @@ -306,7 +305,7 @@ public class DataVector * Get the type of the data value of an element in the data vector. * @param iElementNumber Element whose data value type is to be returned. * @return Returns element's data value type. This will be one of the - * values of {@link xflaim.FlmDataType FlmDataType). + * values of {@link xflaim.FlmDataType FlmDataType}. * @throws XFlaimException */ public int getDataType( diff --git a/xflaim/java/xflaim/Db.java b/xflaim/java/xflaim/Db.java index 07b15f4..bacb612 100644 --- a/xflaim/java/xflaim/Db.java +++ b/xflaim/java/xflaim/Db.java @@ -115,13 +115,13 @@ public class Db * snapshot as the passed in Db object. The passed in Db object should * be running a read transaction. * - * @param Db Database whose transaction is to be copied. + * @param db Database whose transaction is to be copied. * @throws XFlaimException */ public void transBegin( - Db jdb) throws XFlaimException + Db db) throws XFlaimException { - _transBegin( m_this, jdb.m_this); + _transBegin( m_this, db.m_this); } /** @@ -161,7 +161,6 @@ public class Db * time to wait for database lock. Valid values are 0 through 255 seconds. * Zero is used to specify no-wait locks. 255 is used to specify that there * is no timeout. - * @param iTimeoutGet the current transaction type. * @return Returns the type of transaction. Should be one of * the members of {@link xflaim.TransactionType TransactionType}. * @throws XFlaimException @@ -364,7 +363,7 @@ public class Db /** * Creates a new document node. * @param iCollection The collection to store the new document in. - * @return Returns the (@link xflaim.DOMNode DOMNode} representing the new document. + * @return Returns the {@link xflaim.DOMNode DOMNode} representing the new document. * @throws XFlaimException */ public DOMNode createDocument( @@ -388,7 +387,7 @@ public class Db * in the XFlaim database. * @param iCollection The collection to store the new node in. * @param iElementNameId Name of the element to be created. - * @return Returns the (@link xflaim.DOMNode DOMNode} representing the + * @return Returns the {@link xflaim.DOMNode DOMNode} representing the * root element node. * @throws XFlaimException */ @@ -416,7 +415,7 @@ public class Db * @param ReusedNode An existing {@link xflaim.DOMNode DOMNode} object * can optionally be passed in, and it will be reused instead of a new * object being allocated. - * @return - Returns a {@link xflaim.DOMNode DOMNode) which is the root node + * @return - Returns a {@link xflaim.DOMNode DOMNode} which is the root node * of the requested document. * @throws XFlaimException */ @@ -467,7 +466,7 @@ public class Db * @param ReusedNode An existing {@link xflaim.DOMNode DOMNode} object * can optionally be passed in, and it will be reused instead of a new * object being allocated. - * @return - Returns a {@link xflaim.DOMNode DOMNode) which is the root node + * @return - Returns a {@link xflaim.DOMNode DOMNode} which is the root node * of the requested document. * @throws XFlaimException */ @@ -522,7 +521,7 @@ public class Db * @param ReusedNode An existing {@link xflaim.DOMNode DOMNode} object * can optionally be passed in, and it will be reused instead of a new * object being allocated. - * @return - Returns a {@link xflaim.DOMNode DOMNode) which is the root node + * @return - Returns a {@link xflaim.DOMNode DOMNode} which is the root node * of the requested document. * @throws XFlaimException */ @@ -847,7 +846,7 @@ public class Db /** * Creates a new collection in the dictionary. - * @param sEncName The name of the collection. + * @param sCollectionName The name of the collection. * @param iEncNumber ID of the encryption definition that should be used * to encrypt this collection. Zero means the collection will not be encrypted. * @param iRequestedId If non-zero, then xflaim will try to use this @@ -1246,7 +1245,7 @@ public class Db * {@link DictType DictType}.ATTRIBUTE_DEF. * @param iDictNum Number of element or attribute definition whose state * is to be changed. - * @param sState. State the definition is to be changed to. Must be + * @param sState State the definition is to be changed to. Must be * "checking", "purge", or "active". * @throws XFlaimException */ @@ -1297,7 +1296,7 @@ public class Db * no action is taken. * @param iDictType Type of dictionary definition whose "next dictionary * number" is to be changed. Should be a valid {@link xflaim.DictType DictType}. - * @param iDictNumber Next dictionary number. + * @param iNextDictNumber Next dictionary number. * @throws XFlaimException */ public void setNextDictNum( @@ -1547,7 +1546,7 @@ public class Db } /** - * Get the name of the database's control file (e.g. mystuff.db). + * Get the name of the database's control file (e.g. mystuff.db). * @return Returns control file name. * @throws XFlaimException */ diff --git a/xflaim/java/xflaim/DbRebuildStatus.java b/xflaim/java/xflaim/DbRebuildStatus.java index 41422a1..8f6bb49 100644 --- a/xflaim/java/xflaim/DbRebuildStatus.java +++ b/xflaim/java/xflaim/DbRebuildStatus.java @@ -25,9 +25,12 @@ package xflaim; /** - * To change the template for this generated type comment go to - * Window>Preferences>Java>Code Generation>Code and Comments + * This interface alows XFlaim to periodically pass information back to the + * client about the status of an ongoing database rebuild operation. The + * implementor may do anything it wants with the information, such as write + * it to a log file or display it on the screen. */ public interface DbRebuildStatus { } + diff --git a/xflaim/java/xflaim/DbSystem.java b/xflaim/java/xflaim/DbSystem.java index ccc5601..a9ade57 100644 --- a/xflaim/java/xflaim/DbSystem.java +++ b/xflaim/java/xflaim/DbSystem.java @@ -130,7 +130,7 @@ public class DbSystem * @param sPassword Password for opening the database. This is only needed * if the database key is currently wrapped in a password instead of the * local NICI storage key. - * @return Returns an instance of a {@xflaim.Db Db} object. + * @return Returns an instance of a {@link xflaim.Db Db} object. * @throws XFlaimException */ @@ -565,7 +565,7 @@ public class DbSystem * sBaseName.00000002, etc. The extension is a hex number. * @param iMaxFileSize Maximum number of bytes to write to each file in the * multi-file set. - * @param bOkToOverwrite. Flag indicating whether or not the output files + * @param bOkToOverwrite Flag indicating whether or not the output files * should be overwritten if they already exist. * @return Returns an {@link xflaim.OStream OStream} object. * @throws XFlaimException @@ -1165,7 +1165,7 @@ public class DbSystem * Determine if a string has a sub-string in it. * @param sString This is the string that is to be checked to see if it * contains a substring. - * @param bSubString This is the substring that is being looked for. + * @param sSubString This is the substring that is being looked for. * @param iCompareRules Flags for doing string comparisons. Should be * logical ORs of the members of {@link xflaim.CompareRules CompareRules}. * @param iLanguage Language to use for doing collation of strings. diff --git a/xflaim/java/xflaim/Query.java b/xflaim/java/xflaim/Query.java index 0cf7291..a6b4bad 100644 --- a/xflaim/java/xflaim/Query.java +++ b/xflaim/java/xflaim/Query.java @@ -106,7 +106,7 @@ public class Query /** * Copy the query criteria from one Query object into this Query object. - * @param querytoCopy Query object whose criteria is to be copied. + * @param queryToCopy Query object whose criteria is to be copied. * @throws XFlaimException */ public void copyCriteria( @@ -137,7 +137,7 @@ public class Query * Add an operator to a query. * @param iOperator Operator to be added. Should be one of the constants * defined in {@link xflaim.QueryOperators QueryOperators}. - * @param iCompareRules. Flags for doing string comparisons. Should be + * @param iCompareRules Flags for doing string comparisons. Should be * logical ORs of the members of {@link xflaim.CompareRules CompareRules}. * @throws XFlaimException */ @@ -194,7 +194,6 @@ public class Query /** * Add an "unknown" predicate to the query criteria. - * @param bValue Boolean value to be added to criteria. * @throws XFlaimException */ public void addUnknown() throws XFlaimException @@ -700,7 +699,7 @@ public class Query * the result set to be completely built before returning counts. If true, * the method will return the current counts, even if the result set is * not completely built. - * @returns {@link xflaim.ResultSetCounts ResultSetCounts} object which + * @return {@link xflaim.ResultSetCounts ResultSetCounts} object which * contains various counts pertaining to the result set for the query. * @throws XFlaimException */ diff --git a/xflaim/java/xflaim/RestoreStatus.java b/xflaim/java/xflaim/RestoreStatus.java index 3c3a3c8..20a95b3 100644 --- a/xflaim/java/xflaim/RestoreStatus.java +++ b/xflaim/java/xflaim/RestoreStatus.java @@ -60,7 +60,6 @@ public interface RestoreStatus /** * * @param lTransId - * @param iStartTime * @return Returns a status code. The integer should one of the constants * found in {@link xflaim.RCODE xflaim.RCODE}. * Note that returning anything other than NE_XFLM_OK will cause the