Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)

107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/util/schemacomp/model/AbstractDbObject.java

@@ -44,8 +44,8 @@ public abstract class AbstractDbObject implements DbObject
     /**
      * Instantiate, giving the object a parent and a name.
      * 
-     * @param parent
-     * @param name
+     * @param parent DbObject
+     * @param name String
      */
     public AbstractDbObject(DbObject parent, String name)
     {
@@ -158,14 +158,14 @@ public abstract class AbstractDbObject implements DbObject
         sb.append("]");
         
         return sb.toString();
-    }
-
-    /**
-     * Provides an implementation of {@link DbObject#diff(DbObject, DiffContext)}. The template
-     * method {@link #doDiff(DbObject, DiffContext)} provides the subclass specific diffing logic,
-     * whilst this method handles the workflow required in most cases: set the path's prefix that will be
-     * used to explain where differences occur; compare the name fields of the two objects; delegate to the
-     * subclass specific diffing (if any); remove the last path addition ready for the next object to perform
+    }
+
+    /**
+     * Provides an implementation of {@link DbObject#diff(DbObject, DiffContext)}. The template
+     * method {@link #doDiff(DbObject, DiffContext)} provides the subclass specific diffing logic,
+     * whilst this method handles the workflow required in most cases: set the path's prefix that will be
+     * used to explain where differences occur; compare the name fields of the two objects; delegate to the
+     * subclass specific diffing (if any); remove the last path addition ready for the next object to perform
      * its diff correctly.
      */
     @Override
@@ -194,13 +194,13 @@ public abstract class AbstractDbObject implements DbObject
 
     
     /**
-     * Override this method to provide subclass specific diffing logic.
-     * 
-     * @param right
-     * @param ctx
-     */
-    protected void doDiff(DbObject right, DiffContext ctx)
-    {
+     * Override this method to provide subclass specific diffing logic.
+     * 
+     * @param right DbObject
+     * @param ctx DiffContext
+     */
+    protected void doDiff(DbObject right, DiffContext ctx)
+    {
     }
     
 

source/java/org/alfresco/util/schemacomp/model/Column.java

@@ -43,10 +43,10 @@ public class Column extends AbstractDbObject
     /**
      * Construct a Column.
      * 
-     * @table the parent table
-     * @param name
-     * @param type
-     * @param nullable
+     * @param table the parent table
+     * @param name String
+     * @param type String
+     * @param nullable boolean
      */
     public Column(Table table, String name, String type, boolean nullable)
     {

source/java/org/alfresco/util/schemacomp/model/DbObject.java

@@ -42,8 +42,8 @@ public interface DbObject
      * <code>a.sameAs(b) == true</code> it makes it easier to show the differences as related, i.e. a and b are
      * different rather than, a is only in the 'left' tree and b is only in the 'right' tree. 
      *  
-     * @param other
-     * @return
+     * @param other DbObject
+     * @return boolean
      */
     boolean sameAs(DbObject other);
     
@@ -69,7 +69,7 @@ public interface DbObject
      * Allows a visitor to be invoked against this DbObject. Implementations should ensure that child
      * objects are visited first (by calling accept on them) before invoking the visitor on itself.
      * 
-     * @param visitor
+     * @param visitor DbObjectVisitor
      */
     void accept(DbObjectVisitor visitor);
     
@@ -85,7 +85,7 @@ public interface DbObject
      * Sets the parent object.
      * 
      * @see #getParent()
-     * @param parent
+     * @param parent DbObject
      */
     void setParent(DbObject parent);
     
@@ -101,7 +101,7 @@ public interface DbObject
     /**
      * Set/override the validators associated with this database object.
      * 
-     * @param validators
+     * @param validators List<DbValidator>
      */
     void setValidators(List<DbValidator> validators);
     
@@ -116,7 +116,7 @@ public interface DbObject
      * Is there at least one validator that assumes object-level validation
      * that removes the requirement for reporting of differences for this object?
      * 
-     * @return
+     * @return boolean
      */
     boolean hasObjectLevelValidator();
     

source/java/org/alfresco/util/schemacomp/model/ForeignKey.java

@@ -45,10 +45,10 @@ public class ForeignKey extends AbstractDbObject
      * Constructor.
      * 
      * @param table the parent table
-     * @param fkName
-     * @param localColumn
-     * @param targetTable
-     * @param targetColumn
+     * @param fkName String
+     * @param localColumn String
+     * @param targetTable String
+     * @param targetColumn String
      */
     public ForeignKey(Table table, String fkName, String localColumn, String targetTable, String targetColumn)
     {

source/java/org/alfresco/util/schemacomp/model/Index.java

@@ -45,7 +45,7 @@ public class Index extends AbstractDbObject
     
     /**
      * @param table the parent table
-     * @param columnNames
+     * @param columnNames List<String>
      */
     public Index(Table table, String name, List<String> columnNames)
     {
@@ -82,7 +82,7 @@ public class Index extends AbstractDbObject
 
     /**
      * @see #isUnique()
-     * @param unique
+     * @param unique boolean
      */
     public void setUnique(boolean unique)
     {

source/java/org/alfresco/util/schemacomp/model/PrimaryKey.java

@@ -44,8 +44,9 @@ public class PrimaryKey extends AbstractDbObject
     /**
      * Constructor
      * @param table the parent table
-     * @param name
-     * @param columnNames
+     * @param name String
+     * @param columnNames List<String>
+     * @param columnOrders List<Integer>
      */
     public PrimaryKey(Table table, String name, List<String> columnNames, List<Integer> columnOrders)
     {

source/java/org/alfresco/util/schemacomp/model/Schema.java

@@ -45,7 +45,7 @@ public class Schema extends AbstractDbObject implements Iterable<DbObject>
     /**
      * Construct a schema with the given name and no database prefix.
      * 
-     * @param name
+     * @param name String
      */
     public Schema(String name)
     {
@@ -59,8 +59,10 @@ public class Schema extends AbstractDbObject implements Iterable<DbObject>
      * whose names begin with "alf_" will be represented by this schema. Therefore any comparisons
      * should be performed against another similarly filtered Schema object.
      * 
-     * @param name
-     * @param dbPrefix
+     * @param name String
+     * @param dbPrefix String
+     * @param schemaVersion int
+     * @param checkTableColumnOrder boolean
      */
     public Schema(String name, String dbPrefix, int schemaVersion, boolean checkTableColumnOrder)
     {
@@ -92,7 +94,7 @@ public class Schema extends AbstractDbObject implements Iterable<DbObject>
      * Add an object to this schema - this method will set this schema
      * as the object's parent.
      * 
-     * @param dbObject
+     * @param dbObject DbObject
      */
     public void add(DbObject dbObject)
     {
@@ -107,8 +109,8 @@ public class Schema extends AbstractDbObject implements Iterable<DbObject>
     }
 
     /**
-     * @param object
-     * @return
+     * @param object DbObject
+     * @return boolean
      */
     public boolean contains(DbObject object)
     {