Removal of duplicated documentation on methods inherited from a superclass or interface.

The documentation was updated in subclasses that effectively had any difference from the inherited class/interface.
In these cases, the tag {@inheritDoc} was used to extend the documentation in the subclass and avoid documentation duplication.

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/CloudletSchedulerSpaceShared.java

@@ -392,11 +392,12 @@ public class CloudletSchedulerSpaceShared extends CloudletScheduler {
 	}
 
 	/**
-	 * Returns the first cloudlet to migrate to another vm.
+	 * Returns the first cloudlet to migrate to another VM.
 	 * 
 	 * @return the first running cloudlet
 	 * @pre $none
 	 * @post $none
+         * 
          * @todo it doesn't check if the list is empty
 	 */
 	@Override

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/Datacenter.java

@@ -122,14 +122,6 @@ public class Datacenter extends SimEntity {
 		// empty. This should be override by a child class
 	}
 
-	/**
-	 * Processes events or services that are available for this Datacenter.
-	 * 
-	 * @param ev information about the event just happened
-         * 
-	 * @pre ev != null
-	 * @post $none
-	 */
 	@Override
 	public void processEvent(SimEvent ev) {
 		int srcId = -1;

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/DatacenterBroker.java

@@ -146,13 +146,6 @@ public class DatacenterBroker extends SimEntity {
 		CloudletList.getById(getCloudletList(), cloudletId).setVmId(vmId);
 	}
 
-	/**
-	 * Processes events available for this Broker.
-	 * 
-	 * @param ev a SimEvent object
-	 * @pre ev != null
-	 * @post $none
-	 */
 	@Override
 	public void processEvent(SimEvent ev) {
 		switch (ev.getTag()) {

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/HarddriveStorage.java

@@ -111,21 +111,11 @@ public class HarddriveStorage implements Storage {
 		maxTransferRate = 133; // in MB/sec
 	}
 
-	/**
-	 * Gets the available space on this storage in MB.
-	 * 
-	 * @return the available space in MB
-	 */
 	@Override
 	public double getAvailableSpace() {
 		return capacity - currentSize;
 	}
 
-	/**
-	 * Checks if the storage is full or not.
-	 * 
-	 * @return <tt>true</tt> if the storage is full, <tt>false</tt> otherwise
-	 */
 	@Override
 	public boolean isFull() {
 		if (Math.abs(currentSize - capacity) < .0000001) { // currentSize == capacity
@@ -134,22 +124,11 @@ public class HarddriveStorage implements Storage {
 		return false;
 	}
 
-	/**
-	 * Gets the number of files stored on this hard drive.
-	 * 
-	 * @return the number of stored files
-	 */
 	@Override
 	public int getNumStoredFile() {
 		return fileList.size();
 	}
 
-	/**
-	 * Reserves space on the hard drive to store a file.
-	 * 
-	 * @param fileSize the size to be reserved in MB
-	 * @return <tt>true</tt> if reservation succeeded, <tt>false</tt> otherwise
-	 */
 	@Override
 	public boolean reserveSpace(int fileSize) {
 		if (fileSize <= 0) {
@@ -164,13 +143,6 @@ public class HarddriveStorage implements Storage {
 		return true;
 	}
 
-	/**
-	 * Adds a file for which the space has already been reserved. The time taken (in seconds) for
-	 * adding the file can also be found using {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param file the file to be added
-	 * @return the time (in seconds) required to add the file
-	 */
 	@Override
 	public double addReservedFile(File file) {
 		if (file == null) {
@@ -188,12 +160,6 @@ public class HarddriveStorage implements Storage {
 		return result;
 	}
 
-	/**
-	 * Checks whether there is enough space on the hard drive for a certain file.
-	 * 
-	 * @param fileSize a FileAttribute object to compare to
-	 * @return <tt>true</tt> if enough space available, <tt>false</tt> otherwise
-	 */
 	@Override
 	public boolean hasPotentialAvailableSpace(int fileSize) {
 		if (fileSize <= 0) {
@@ -227,31 +193,16 @@ public class HarddriveStorage implements Storage {
 		return result;
 	}
 
-	/**
-	 * Gets the total capacity of the storage in MB.
-	 * 
-	 * @return the capacity of the storage in MB
-	 */
 	@Override
 	public double getCapacity() {
 		return capacity;
 	}
 
-	/**
-	 * Gets the current size of the stored files in MB.
-	 * 
-	 * @return the current size of the stored files in MB
-	 */
 	@Override
 	public double getCurrentSize() {
 		return currentSize;
 	}
 
-	/**
-	 * Gets the name of the storage.
-	 * 
-	 * @return the name of this storage
-	 */
 	@Override
 	public String getName() {
 		return name;
@@ -281,12 +232,6 @@ public class HarddriveStorage implements Storage {
 		return latency;
 	}
 
-	/**
-	 * Sets the maximum transfer rate of this storage system in MB/sec.
-	 * 
-	 * @param rate the maximum transfer rate in MB/sec
-	 * @return <tt>true</tt> if the setting succeeded, <tt>false</tt> otherwise
-	 */
 	@Override
 	public boolean setMaxTransferRate(int rate) {
 		if (rate <= 0) {
@@ -297,11 +242,6 @@ public class HarddriveStorage implements Storage {
 		return true;
 	}
 
-	/**
-	 * Gets the maximum transfer rate of the storage in MB/sec.
-	 * 
-	 * @return the maximum transfer rate in MB/sec
-	 */
 	@Override
 	public double getMaxTransferRate() {
 		return maxTransferRate;
@@ -344,13 +284,6 @@ public class HarddriveStorage implements Storage {
 		return avgSeekTime;
 	}
 
-	/**
-	 * Gets the file with the specified name. The time taken (in seconds) for getting the file can
-	 * also be found using {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param fileName the name of the needed file
-	 * @return the file with the specified filename
-	 */
 	@Override
 	public File getFile(String fileName) {
 		// check first whether file name is valid or not
@@ -392,11 +325,6 @@ public class HarddriveStorage implements Storage {
 		return obj;
 	}
 
-	/**
-	 * Gets the list of file names located on this storage.
-	 * 
-	 * @return a List of file names
-	 */
 	@Override
 	public List<String> getFileNameList() {
 		return nameList;
@@ -464,13 +392,13 @@ public class HarddriveStorage implements Storage {
 	}
 
 	/**
-	 * Adds a file to the storage. First, the method checks if there is enough space on the storage,
-	 * then it checks if the file with the same name is already taken to avoid duplicate filenames. <br>
-	 * The time taken (in seconds) for adding the file can also be found using
-	 * {@link gridsim.datagrid.File#getTransactionTime()}.
+	 * {@inheritDoc}
+         * 
+         * <p/>First, the method checks if there is enough space on the storage,
+	 * then it checks if the file with the same name is already taken to avoid duplicate filenames. 
 	 * 
-	 * @param file the file to be added
-	 * @return the time taken (in seconds) for adding the specified file
+	 * @param file {@inheritDoc}
+	 * @return {@inheritDoc}
 	 */
 	@Override
 	public double addFile(File file) {
@@ -500,14 +428,6 @@ public class HarddriveStorage implements Storage {
 		return result;
 	}
 
-	/**
-	 * Adds a set of files to the storage. Runs through the list of files and save all of them. The
-	 * time taken (in seconds) for adding each file can also be found using
-	 * {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param list the files to be added
-	 * @return the time taken (in seconds) for adding the specified files
-	 */
 	@Override
 	public double addFile(List<File> list) {
 		double result = 0.0;
@@ -525,13 +445,6 @@ public class HarddriveStorage implements Storage {
 		return result;
 	}
 
-	/**
-	 * Removes a file from the storage. The time taken (in seconds) for deleting the file can also
-	 * be found using {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param fileName the name of the file to be removed
-	 * @return the deleted file
-	 */
 	@Override
 	public File deleteFile(String fileName) {
 		if (fileName == null || fileName.length() == 0) {
@@ -556,26 +469,11 @@ public class HarddriveStorage implements Storage {
 		return file;
 	}
 
-	/**
-	 * Removes a file from the storage. The time taken (in seconds) for deleting the file can also
-	 * be found using {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param fileName the name of the file to be removed
-	 * @param file the file which is removed from the storage is returned through this parameter
-	 * @return the time taken (in seconds) for deleting the specified file
-	 */
 	@Override
 	public double deleteFile(String fileName, File file) {
 		return deleteFile(file);
 	}
 
-	/**
-	 * Removes a file from the storage. The time taken (in seconds) for deleting the file can also
-	 * be found using {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param file the file which is removed from the storage is returned through this parameter
-	 * @return the time taken (in seconds) for deleting the specified file
-	 */
 	@Override
 	public double deleteFile(File file) {
 		double result = 0.0;
@@ -597,12 +495,6 @@ public class HarddriveStorage implements Storage {
 		return result;
 	}
 
-	/**
-	 * Checks whether a certain file is on the storage or not.
-	 * 
-	 * @param fileName the name of the file we are looking for
-	 * @return <tt>true</tt> if the file is in the storage, <tt>false</tt> otherwise
-	 */
 	@Override
 	public boolean contains(String fileName) {
 		boolean result = false;
@@ -622,12 +514,6 @@ public class HarddriveStorage implements Storage {
 		return result;
 	}
 
-	/**
-	 * Checks whether a certain file is on the storage or not.
-	 * 
-	 * @param file the file we are looking for
-	 * @return <tt>true</tt> if the file is in the storage, <tt>false</tt> otherwise
-	 */
 	@Override
 	public boolean contains(File file) {
 		boolean result = false;
@@ -639,14 +525,6 @@ public class HarddriveStorage implements Storage {
 		return result;
 	}
 
-	/**
-	 * Renames a file on the storage. The time taken (in seconds) for renaming the file can also be
-	 * found using {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param file the file we would like to rename
-	 * @param newName the new name of the file
-	 * @return <tt>true</tt> if the renaming succeeded, <tt>false</tt> otherwise
-	 */
 	@Override
 	public boolean renameFile(File file, String newName) {
 		// check whether the new filename is conflicting with existing ones

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/ParameterException.java

@@ -55,13 +55,6 @@ public class ParameterException extends Exception {
 		this.message = message;
 	}
 
-	/**
-	 * Returns an error message of this object.
-	 * 
-	 * @return an error message
-	 * @pre $none
-	 * @post $none
-	 */
 	@Override
 	public String toString() {
 		return message;

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/SanStorage.java

@@ -60,12 +60,6 @@ public class SanStorage extends HarddriveStorage {
 		this.networkLatency = networkLatency;
 	}
 
-	/**
-	 * Adds a file for which the space has already been reserved.
-	 * 
-	 * @param file the file to be added
-	 * @return the time (in seconds) required to add the file
-	 */
 	@Override
 	public double addReservedFile(File file) {
 		double time = super.addReservedFile(file);
@@ -75,11 +69,6 @@ public class SanStorage extends HarddriveStorage {
 		return time;
 	}
 
-	/**
-	 * Gets the maximum transfer rate of the storage in MB/sec.
-	 * 
-	 * @return the maximum transfer rate in MB/sec
-	 */
 	@Override
 	public double getMaxTransferRate() {
 
@@ -93,12 +82,6 @@ public class SanStorage extends HarddriveStorage {
 		return bandwidth;
 	}
 
-	/**
-	 * Adds a file to the storage.
-	 * 
-	 * @param file the file to be added
-	 * @return the time taken (in seconds) for adding the specified file
-	 */
 	@Override
 	public double addFile(File file) {
 		double time = super.addFile(file);
@@ -109,14 +92,6 @@ public class SanStorage extends HarddriveStorage {
 		return time;
 	}
 
-	/**
-	 * Adds a set of files to the storage. Runs through the list of files and save all of them. The
-	 * time taken (in seconds) for adding each file can also be found using
-	 * {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param list the files to be added
-	 * @return the time taken (in seconds) for adding the specified files
-	 */
 	@Override
 	public double addFile(List<File> list) {
 		double result = 0.0;
@@ -134,26 +109,11 @@ public class SanStorage extends HarddriveStorage {
 		return result;
 	}
 
-	/**
-	 * Removes a file from the storage. The time taken (in seconds) for deleting the file can also
-	 * be found using {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param fileName the name of the file to be removed
-	 * @param file the file which is removed from the storage is returned through this parameter
-	 * @return the time taken (in seconds) for deleting the specified file
-	 */
 	@Override
 	public double deleteFile(String fileName, File file) {
 		return this.deleteFile(file);
 	}
 
-	/**
-	 * Removes a file from the storage. The time taken (in seconds) for deleting the file can also
-	 * be found using {@link gridsim.datagrid.File#getTransactionTime()}.
-	 * 
-	 * @param file the file which is removed from the storage is returned through this parameter
-	 * @return the time taken (in seconds) for deleting the specified file
-	 */
 	@Override
 	public double deleteFile(File file) {
 		double time = super.deleteFile(file);

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/Storage.java

@@ -91,7 +91,7 @@ public interface Storage {
 	/**
 	 * Adds a file for which the space has already been reserved. The time taken (in seconds) for
 	 * adding the specified file can also be found using
-	 * {@link gridsim.datagrid.File#getTransactionTime()}.
+	 * {@link org.cloudbus.cloudsim.File#getTransactionTime()}.
 	 * 
 	 * @param file the file to be added
 	 * @return the time (in seconds) required to add the file
@@ -108,7 +108,7 @@ public interface Storage {
 
 	/**
 	 * Gets the file with the specified name. The time taken (in seconds) for getting the specified
-	 * file can also be found using {@link gridsim.datagrid.File#getTransactionTime()}.
+	 * file can also be found using {@link org.cloudbus.cloudsim.File#getTransactionTime()}.
 	 * 
 	 * @param fileName the name of the needed file
 	 * @return the file with the specified filename
@@ -124,7 +124,7 @@ public interface Storage {
 
 	/**
 	 * Adds a file to the storage. The time taken (in seconds) for adding the specified file can
-	 * also be found using {@link gridsim.datagrid.File#getTransactionTime()}.
+	 * also be found using {@link org.cloudbus.cloudsim.File#getTransactionTime()}.
 	 * 
 	 * @param file the file to be added
 	 * @return the time taken (in seconds) for adding the specified file
@@ -154,7 +154,7 @@ public interface Storage {
 	 * can also be found using {@link gridsim.datagrid.File#getTransactionTime()}.
 	 * 
 	 * @param fileName the name of the file to be removed
-	 * @param file the file which is removed from the storage is returned through this parameter
+	 * @param file the file removed from the storage is returned through this parameter
 	 * @return the time taken (in seconds) for deleting the specified file
 	 */
 	double deleteFile(String fileName, File file);
@@ -163,13 +163,13 @@ public interface Storage {
 	 * Removes a file from the storage. The time taken (in seconds) for deleting the specified file
 	 * can also be found using {@link gridsim.datagrid.File#getTransactionTime()}.
 	 * 
-	 * @param file the file which is removed from the storage is returned through this parameter
+	 * @param file the file to be removed
 	 * @return the time taken (in seconds) for deleting the specified file
 	 */
 	double deleteFile(File file);
 
 	/**
-	 * Checks whether a file is stored in the storage or not.
+	 * Checks whether a file exists in the storage or not.
 	 * 
 	 * @param fileName the name of the file we are looking for
 	 * @return <tt>true</tt> if the file is in the storage, <tt>false</tt> otherwise
@@ -186,7 +186,7 @@ public interface Storage {
 
 	/**
 	 * Renames a file on the storage. The time taken (in seconds) for renaming the specified file
-	 * can also be found using {@link gridsim.datagrid.File#getTransactionTime()}.
+	 * can also be found using {@link org.cloudbus.cloudsim.File#getTransactionTime()}.
 	 * 
 	 * @param file the file we would like to rename
 	 * @param newName the new name of the file

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/VmAllocationPolicy.java

@@ -38,10 +38,9 @@ public abstract class VmAllocationPolicy {
 	}
 
 	/**
-	 * Allocates a host for a given VM. The host to be allocated is the one that was already
-	 * reserved.
+	 * Allocates a host for a given VM.
 	 * 
-	 * @param vm virtual machine which the host is reserved to
+	 * @param vm the VM to allocate a host to
 	 * @return $true if the host could be allocated; $false otherwise
 	 * @pre $none
 	 * @post $none
@@ -76,7 +75,7 @@ public abstract class VmAllocationPolicy {
 	/**
 	 * Releases the host used by a VM.
 	 * 
-	 * @param vm the vm
+	 * @param vm the vm to get its host released
 	 * @pre $none
 	 * @post $none
 	 */

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/VmAllocationPolicySimple.java

@@ -58,10 +58,10 @@ public class VmAllocationPolicySimple extends VmAllocationPolicy {
 	}
 
 	/**
-	 * Allocates a host for a given VM.
+	 * Allocates the host with less PEs in use for a given VM.
 	 * 
-	 * @param vm the VM to allocate a host to
-	 * @return $true if the host could be allocated; $false otherwise
+	 * @param vm {@inheritDoc}
+	 * @return {@inheritDoc}
 	 * @pre $none
 	 * @post $none
 	 */
@@ -108,13 +108,6 @@ public class VmAllocationPolicySimple extends VmAllocationPolicy {
 		return result;
 	}
 
-	/**
-	 * Releases the host used by a VM.
-	 * 
-	 * @param vm the vm to get its host released
-	 * @pre $none
-	 * @post none
-	 */
 	@Override
 	public void deallocateHostForVm(Vm vm) {
 		Host host = getVmTable().remove(vm.getUid());

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/CloudInformationService.java

@@ -76,12 +76,6 @@ public class CloudInformationService extends SimEntity {
 	public void startEntity() {
 	}
 
-	/**
-	 * Processes events scheduled for the CIS.
-	 * 
-	 * @param ev the event to be handled.
-	 * @see SimEntity#processEvent(SimEvent)
-	 */
 	@Override
 	public void processEvent(SimEvent ev) {
 		int id = -1;  // requester id
@@ -138,9 +132,6 @@ public class CloudInformationService extends SimEntity {
 		}
 	}
 
-	/**
-	 * Shutdowns the CloudInformationService.
-	 */
 	@Override
 	public void shutdownEntity() {
 		notifyAllEntity();

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/CloudSimShutdown.java

@@ -81,7 +81,7 @@ public class CloudSimShutdown extends SimEntity {
 	public void startEntity() {
 		// do nothing
 	}
-
+        
         /**
          * The method has no effect at the current class.
          */
@@ -89,5 +89,4 @@ public class CloudSimShutdown extends SimEntity {
 	public void shutdownEntity() {
 		// do nothing
 	}
-
 }

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/SimEntity.java

@@ -394,14 +394,19 @@ public abstract class SimEntity implements Cloneable {
 	public abstract void startEntity();
 
 	/**
+	 * Processes events or services that are available for the entity.
 	 * This method is invoked by the {@link CloudSim} class whenever there is an event in the
 	 * deferred queue, which needs to be processed by the entity.
 	 * 
-	 * @param ev the event to be processed by the entity
+	 * @param ev information about the event just happened
+         * 
+	 * @pre ev != null
+	 * @post $none
 	 */
 	public abstract void processEvent(SimEvent ev);
 
 	/**
+         * Shuts down the entity.
 	 * This method is invoked by the {@link CloudSim} before the simulation finishes. If you want
 	 * to save data in log files this is the method in which the corresponding code would be placed.
 	 */

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/SimEvent.java

@@ -215,11 +215,6 @@ public class SimEvent implements Cloneable, Comparable<SimEvent> {
 		return data;
 	}
 
-	/**
-	 * Create an exact copy of this event.
-	 * 
-	 * @return The event's copy
-	 */
 	@Override
 	public Object clone() {
 		return new SimEvent(etype, time, entSrc, entDst, tag, data);

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/predicates/PredicateAny.java

@@ -29,7 +29,7 @@ public class PredicateAny extends Predicate {
 	 * Considers there is no criteria to match an event,
          * so any event received by the predicate will match.
 	 * 
-	 * @param ev the event received
+	 * @param ev {@inheritDoc}
 	 * @return always true to indicate that any received event is accepted
 	 */
 	@Override

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/predicates/PredicateFrom.java

@@ -45,8 +45,8 @@ public class PredicateFrom extends Predicate {
 	/**
 	 * Matches any event received from the registered sources.
 	 * 
-	 * @param ev the event to check
-	 * @return <code>true</code> if the event matches the predicate, <code>false</code> otherwise
+	 * @param ev {@inheritDoc}
+	 * @return {@inheritDoc}
          * @see #ids
 	 */
 	@Override

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/predicates/PredicateNone.java

@@ -26,12 +26,11 @@ public class PredicateNone extends Predicate {
 	/**
 	 * Considers that no event received by the predicate matches.
 	 * 
-	 * @param ev the event received
+	 * @param ev {@inheritDoc}
 	 * @return always false to indicate that no event is accepted
 	 */
 	@Override
 	public boolean match(SimEvent ev) {
 		return false;
 	}
-
 }

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/predicates/PredicateNotFrom.java

@@ -44,8 +44,8 @@ public class PredicateNotFrom extends Predicate {
 	/**
 	 * Matches any event <b>not</b> received from the registered sources.
 	 * 
-	 * @param ev the event to check
-	 * @return <code>true</code> if the event matches the predicate, <code>false</code> otherwise
+	 * @param ev {@inheritDoc}
+	 * @return {@inheritDoc}
          * @see #ids
 	 */
 	@Override

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/predicates/PredicateNotType.java

@@ -44,8 +44,8 @@ public class PredicateNotType extends Predicate {
 	/**
 	 * Matches any event that hasn't one of the specified {@link #tags}.
 	 * 
-	 * @param ev the event to check
-	 * @return <code>true</code> if the event matches the predicate, <code>false</code> otherwise
+	 * @param ev {@inheritDoc}
+	 * @return {@inheritDoc}
          * @see #tags
 	 */
 	@Override

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/core/predicates/PredicateType.java

@@ -44,8 +44,8 @@ public class PredicateType extends Predicate {
 	/**
 	 * Matches any event that has one of the specified {@link #tags}.
 	 * 
-	 * @param ev the event to check
-	 * @return <code>true</code> if the event matches the predicate, <code>false</code> otherwise
+	 * @param ev {@inheritDoc}
+	 * @return {@inheritDoc}
          * @see #tags
 	 */
 	@Override

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/lists/CloudletList.java

@@ -67,13 +67,13 @@ public class CloudletList {
 		Collections.sort(cloudletList, new Comparator<T>() {
 
 			/**
-			 * Compares two objects.
+			 * Compares two Cloudlets.
 			 * 
-			 * @param a the first Object to be compared
-			 * @param b the second Object to be compared
-			 * @return the value 0 if both Objects are numerically equal; a value less than 0 if the
-			 *         first Object is numerically less than the second Object; and a value greater
-			 *         than 0 if the first Object is numerically greater than the second Object.
+			 * @param a the first Cloudlet to be compared
+			 * @param b the second Cloudlet to be compared
+			 * @return the value 0 if both Cloudlets are numerically equal; a value less than 0 if the
+			 *         first Object is numerically less than the second Cloudlet; and a value greater
+			 *         than 0 if the first Cloudlet is numerically greater than the second Cloudlet.
 			 * @throws ClassCastException <tt>a</tt> and <tt>b</tt> are expected to be of type
 			 *             <tt>Cloudlet</tt>
 			 * @pre a != null

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/network/datacenter/NetworkVmAllocationPolicy.java

@@ -20,8 +20,8 @@ import org.cloudbus.cloudsim.VmAllocationPolicy;
 import org.cloudbus.cloudsim.core.CloudSim;
 
 /**
- * NetworkVmAllocationPolicy is an {@link VmAllocationPolicy} that chooses, as the host for a VM, the host
- * with less PEs in use.
+ * NetworkVmAllocationPolicy is an {@link VmAllocationPolicy} that chooses, 
+ * as the host for a VM, the host with less PEs in use.
  * 
  * @author Rodrigo N. Calheiros
  * @author Anton Beloglazov
@@ -63,11 +63,11 @@ public class NetworkVmAllocationPolicy extends VmAllocationPolicy {
 	}
 
 	/**
-	 * Allocates a host for a given VM.
+	 * Allocates the host with less PEs in use for a given VM.
 	 * 
-	 * @param vm VM specification
+	 * @param vm {@inheritDoc}
 	 * 
-	 * @return $true if the host could be allocated; $false otherwise
+	 * @return {@inheritDoc}
 	 * 
 	 * @pre $none
 	 * @post $none
@@ -145,14 +145,6 @@ public class NetworkVmAllocationPolicy extends VmAllocationPolicy {
 		return maxUtilization;
 	}
 
-	/**
-	 * Releases the host used by a VM.
-	 * 
-	 * @param vm the vm
-	 * 
-	 * @pre $none
-	 * @post none
-	 */
 	@Override
 	public void deallocateHostForVm(Vm vm) {
 		Host host = getVmTable().remove(vm.getUid());
@@ -164,32 +156,11 @@ public class NetworkVmAllocationPolicy extends VmAllocationPolicy {
 		}
 	}
 
-	/**
-	 * Gets the host that is executing the given VM.
-	 * 
-	 * @param vm the vm to get its host
-	 * 
-	 * @return the Host of the given vm; $null if not found
-	 * 
-	 * @pre $none
-	 * @post $none
-	 */
 	@Override
 	public Host getHost(Vm vm) {
 		return getVmTable().get(vm.getUid());
 	}
 
-	/**
-	 * Gets the host that is executing the given VM belonging to the given user.
-	 * 
-	 * @param vmId the vm id
-	 * @param userId the user id
-	 * 
-	 * @return the Host of the given vm and user; $null if not found
-	 * 
-	 * @pre $none
-	 * @post $none
-	 */
 	@Override
 	public Host getHost(int vmId, int userId) {
 		return getVmTable().get(Vm.getUid(userId, vmId));

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/power/PowerVmAllocationPolicySimple.java

@@ -15,8 +15,7 @@ import org.cloudbus.cloudsim.Host;
 import org.cloudbus.cloudsim.Vm;
 
 /**
- * A class representing a simple VM allocation policy that does not perform any
- * optimization of the VM allocation.
+ * A simple VM allocation policy that does <b>not</b> perform any optimization on VM allocation.
  * 
  * <br/>If you are using any algorithms, policies or workload included in the power package please cite
  * the following paper:<br/>

modules/cloudsim/src/main/java/org/cloudbus/cloudsim/util/WorkloadModel.java

@@ -25,9 +25,10 @@ import org.cloudbus.cloudsim.Cloudlet;
 public interface WorkloadModel {
 
 	/**
-	 * Generates a list of jobs to be executed ({@link Cloudlet Cloudlets}).
+	 * Generates a list of jobs ({@link Cloudlet Cloudlets}) to be executed.
 	 * 
-	 * @return a list with the jobs generated by the workload or null in case of failure.
+	 * @return a list with the jobs ({@link Cloudlet Cloudlets}) 
+         * generated by the workload or null in case of failure.
 	 */
 	List<Cloudlet> generateWorkload();