Fix some JavaDoc comments.

This commit is contained in:
hns 2004-07-29 12:22:44 +00:00
parent b72efe9dfb
commit f89a057ffb
2 changed files with 15 additions and 13 deletions

View file

@ -74,10 +74,12 @@ public class Main {
/**
* Create a Helma <code>ClassLoader</code> from the Helma install directory.
* Create a server-wide ClassLoader from our install directory.
* This will be used as parent ClassLoader for all application
* ClassLoaders.
*
* @param installDir
* @return
* @return the main classloader we'll be using
* @throws MalformedURLException
*/
public static FilteredClassLoader createClassLoader(String installDir)
@ -146,7 +148,7 @@ public class Main {
* System property "helma.home" is set to the install directory path.
*
* @param args
* @return
* @return the base install directory we're running in
* @throws IOException
* @throws MalformedURLException
*/

View file

@ -137,9 +137,9 @@ public final class XmlDatabase implements IDatabase {
}
/**
* Get the next free id to use for new objects
* Get the id for the next new object to be stored.
*
* @return
* @return the id for the next new object to be stored
* @throws ObjectNotFoundException
*/
public String nextID() throws ObjectNotFoundException {
@ -151,10 +151,10 @@ public final class XmlDatabase implements IDatabase {
}
/**
* Get the id-generator
* Get the id-generator for this database.
*
* @param txn
* @return
* @return the id-generator for this database
* @throws ObjectNotFoundException
*/
public IDGenerator getIDGenerator(ITransaction txn)
@ -167,7 +167,7 @@ public final class XmlDatabase implements IDatabase {
}
/**
* Write the id-generator to file
* Write the id-generator to file.
*
* @param txn
* @param idgen
@ -191,11 +191,11 @@ public final class XmlDatabase implements IDatabase {
/**
* Retrieves a Node from the database.
*
* @param txn
* @param kstr
* @return
* @throws IOException
* @throws ObjectNotFoundException
* @param txn the current transaction
* @param kstr the key
* @return the object associated with the given key
* @throws IOException if an I/O error occurred loading the object.
* @throws ObjectNotFoundException if no object is stored by this key.
*/
public INode getNode(ITransaction txn, String kstr)
throws IOException, ObjectNotFoundException {