Make javadoc and some cosmetic changes

5 files changed, 18 insertions, 1 deletions

diff --git a/src/main/java/org/openslx/imagemaster/db/DbImage.java b/src/main/java/org/openslx/imagemaster/db/DbImage.java
index 6c64d06..dc2ab34 100644
--- a/src/main/java/org/openslx/imagemaster/db/DbImage.java
+++ b/src/main/java/org/openslx/imagemaster/db/DbImage.java
@@ -10,6 +10,10 @@ import org.openslx.imagemaster.serverconnection.UploadingImage;
 import org.openslx.imagemaster.thrift.iface.ImageData;
 import org.openslx.imagemaster.util.Util;
 
+/**
+ * Representing an image in the database.
+ * Is used to modify/update database entries.
+ */
 public class DbImage
 {
 
@@ -136,6 +140,7 @@ public class DbImage
 
 	/**
 	 * Updates the missing blocks of an uploading image.
+	 * 
 	 * @param missingBlocks
 	 * @return
 	 */
@@ -152,6 +157,7 @@ public class DbImage
 
 	/**
 	 * Updates the database with a new version of an image and its missing blocks.
+	 * 
 	 * @param version
 	 * @param amountBlocks
 	 */
@@ -168,6 +174,7 @@ public class DbImage
 
 	/**
 	 * Marks an image as _deleted_ in the database.
+	 * 
 	 * @return
 	 */
 	public int delete()
@@ -177,6 +184,7 @@ public class DbImage
 
 	/**
 	 * Returns all images from database where blocks are still missing.
+	 * 
 	 * @return
 	 */
 	public static List<DbImage> getUploadingImages()
@@ -190,6 +198,7 @@ public class DbImage
 
 	/**
 	 * Returns the image that is corrsponding to a specified uuid.
+	 * 
 	 * @param uuid
 	 * @return
 	 */
diff --git a/src/main/java/org/openslx/imagemaster/db/DbSatellite.java b/src/main/java/org/openslx/imagemaster/db/DbSatellite.java
index f8bf036..fb35fb5 100644
--- a/src/main/java/org/openslx/imagemaster/db/DbSatellite.java
+++ b/src/main/java/org/openslx/imagemaster/db/DbSatellite.java
@@ -2,6 +2,10 @@ package org.openslx.imagemaster.db;
 
 import org.openslx.imagemaster.util.ByteArray;
 
+/**
+ * Represents a satellite in the database.
+ * Is used to authenticate the satellite.
+ */
 public class DbSatellite
 {
 
diff --git a/src/main/java/org/openslx/imagemaster/db/DbUser.java b/src/main/java/org/openslx/imagemaster/db/DbUser.java
index 7f83176..91e0615 100644
--- a/src/main/java/org/openslx/imagemaster/db/DbUser.java
+++ b/src/main/java/org/openslx/imagemaster/db/DbUser.java
@@ -3,6 +3,9 @@ package org.openslx.imagemaster.db;
 import org.apache.log4j.Logger;
 import org.openslx.imagemaster.session.User;
 
+/**
+ * Represents a user that can login against the masterserver.
+ */
 public class DbUser extends User
 {
 
diff --git a/src/main/java/org/openslx/imagemaster/db/LdapUser.java b/src/main/java/org/openslx/imagemaster/db/LdapUser.java
index 39bbb69..2812755 100644
--- a/src/main/java/org/openslx/imagemaster/db/LdapUser.java
+++ b/src/main/java/org/openslx/imagemaster/db/LdapUser.java
@@ -28,7 +28,7 @@ import org.openslx.imagemaster.util.Sha512Crypt;
 /**
  * Represents a user instance that was queries (primarily) from LDAP.
  * Additional information that is not provided by the LDAP server might
- * be fetched from other sources, like the local database.
+ * be fetched from other sources, like the local database (DbUser.java).
  */
 public class LdapUser extends User
 {
diff --git a/src/main/java/org/openslx/imagemaster/db/MySQL.java b/src/main/java/org/openslx/imagemaster/db/MySQL.java
index 06496ea..3b5438d 100644
--- a/src/main/java/org/openslx/imagemaster/db/MySQL.java
+++ b/src/main/java/org/openslx/imagemaster/db/MySQL.java
@@ -21,6 +21,7 @@ import fi.evident.dalesbred.Database;
  */
 class MySQL
 {
+
 	private static final Logger log = Logger.getLogger( MySQL.class );
 	private static Database db = null;