Add missing JavaDoc.

This commit is contained in:
Michael Jumper
2013-02-20 21:57:05 -08:00
parent 9d3224aaaa
commit 55f7d1deb3
4 changed files with 18 additions and 2 deletions

View File

@@ -52,6 +52,9 @@ import javax.servlet.http.HttpSession;
*/ */
public class Credentials implements Serializable { public class Credentials implements Serializable {
/**
* Unique identifier associated with this specific version of Credentials.
*/
private static final long serialVersionUID = 1L; private static final long serialVersionUID = 1L;
/** /**

View File

@@ -95,9 +95,7 @@ public interface Directory<IdentifierType, ObjectType> {
/** /**
* Updates the stored object with the data contained in the given object. * Updates the stored object with the data contained in the given object.
* The object to update is identified using the identifier given.
* *
* @param identifier The identifier of the object to update.
* @param object The object which will supply the data for the update. * @param object The object which will supply the data for the update.
* *
* @throws GuacamoleException If an error occurs while updating the object, * @throws GuacamoleException If an error occurs while updating the object,

View File

@@ -46,6 +46,9 @@ import java.io.File;
*/ */
public class GuacamoleHome { public class GuacamoleHome {
/**
* GuacamoleHome is a utility class and cannot be instantiated.
*/
private GuacamoleHome() {} private GuacamoleHome() {}
/** /**

View File

@@ -58,6 +58,9 @@ import net.sourceforge.guacamole.GuacamoleServerException;
*/ */
public class GuacamoleProperties { public class GuacamoleProperties {
/**
* GuacamoleProperties is a utility class and cannot be instantiated.
*/
private GuacamoleProperties() {} private GuacamoleProperties() {}
/** /**
@@ -81,7 +84,16 @@ public class GuacamoleProperties {
}; };
/**
* All properties read from guacamole.properties when this class was first
* used.
*/
private static final Properties properties; private static final Properties properties;
/**
* Any error encountered when reading guacamole.properties was last
* attempted.
*/
private static GuacamoleException exception; private static GuacamoleException exception;
static { static {