Merged 5.2.N (5.2.1) to HEAD (5.2)

128510 mmuller: Fixed some javadoc errors. REPO-466


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

source/java/org/alfresco/repo/web/scripts/archive/AbstractArchivedNodeWebScript.java

@@ -174,7 +174,6 @@ public abstract class AbstractArchivedNodeWebScript extends DeclarativeWebScript
      * @param storeRef mandatory store ref
      * @param paging mandatory paging
      * @param filter optional filter
-     * @return PagingResults<NodeRef>
      */
     protected PagingResults<NodeRef> getArchivedNodesFrom(StoreRef storeRef, ScriptPagingDetails paging, String filter)
     {

source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java

@@ -57,7 +57,6 @@ public class ArchivedNodesGet extends AbstractArchivedNodeWebScript
     /**
      * This method is used to inject {@link org.alfresco.repo.web.scripts.archive.ArchivedNodesFilter node filters} on this GET call.
      * 
-     * @param nodeFilters List<ArchivedNodesFilter>
      */
     public void setArchivedNodeFilters(List<ArchivedNodesFilter> nodeFilters)
     {

source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java

@@ -507,7 +507,6 @@ public class ContentStreamer implements ResourceLoaderAware
      * @param res WebScriptResponse
      * @param modified Date
      * @param eTag String
-     * @param model Map<String, Object>
      */
     protected void setResponseCache(WebScriptResponse res, Date modified, String eTag, Map<String, Object> model)
     {

source/java/org/alfresco/repo/web/scripts/content/MimetypesGet.java

@@ -145,7 +145,6 @@ public class MimetypesGet extends DeclarativeWebScript implements ApplicationCon
      * Sets the map of content transformer worker bean names to
      * message formatting labels
      * 
-     * @param knownWorkerBeanLabels Map<String, String>
      */
     public void setKnownWorkerBeanLabels(Map<String, String> knownWorkerBeanLabels)
     {

source/java/org/alfresco/repo/web/scripts/discussion/ForumTopicsFilteredGet.java

@@ -198,7 +198,6 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript
     * @param searchQuery Pair with query string in first and query language in second
     * @param sortAscending boolean
     * @param paging PagingRequest
-    * @return PagingResults<TopicInfo>
     */
    protected PagingResults<TopicInfo> doSearch(Pair<String, String> searchQuery, boolean sortAscending, PagingRequest paging)
    {
@@ -317,7 +316,6 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript
     * 
     * @param finalResults ResultSet
     * @param paging PagingRequest
-    * @return PagingResults<TopicInfo>
     */
    protected PagingResults<TopicInfo> wrap(final ResultSet finalResults, PagingRequest paging)
    {

source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java

@@ -174,7 +174,6 @@ public class StatsGet extends DeclarativeWebScript
      * Parses ISO8601 formatted Date Strings.
      * @param start If start is null then defaults to 1 month
      * @param end If end is null then it defaults to now();
-     * @return Pair <Start,End>
      */
     public static Pair<LocalDate, LocalDate> getStartAndEndDates(String start, String end)
     {

source/java/org/alfresco/repo/webdav/LockInfoImpl.java

@@ -176,7 +176,6 @@ public class LockInfoImpl implements Serializable, LockInfo
     /**
      * Getter for sharedLockTokens list.
      * 
-     * @return LinkedList<String>
      */
     @Override
     public Set<String> getSharedLockTokens()
@@ -187,7 +186,6 @@ public class LockInfoImpl implements Serializable, LockInfo
     /**
      * Setter for sharedLockTokens list.
      * 
-     * @param sharedLockTokens Set<String>
      */
     @Override
     public void setSharedLockTokens(Set<String> sharedLockTokens)

source/java/org/alfresco/repo/webdav/WebDAV.java

@@ -329,7 +329,6 @@ public class WebDAV
     /**
      * Return the Alfresco property value for the specified WebDAV property
      * 
-     * @param props Map<QName, Serializable>
      * @param davPropName String
      * @return Object
      */

source/java/org/alfresco/repo/webdav/WebDAVHelper.java

@@ -160,7 +160,7 @@ public class WebDAVHelper
      * to detect whether clients are performing a renaming shuffle - common during
      * file saving on various clients.
      * <p/>
-     * <bALF-3856, ALF-7079, MNT-181</b>
+     * <b>ALF-3856, ALF-7079, MNT-181</b>
      * 
      * @param renameShufflePattern      a regular expression filename match
      */

source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java

@@ -76,7 +76,6 @@ public class PublicApiAuthenticatorFactory extends RemoteUserAuthenticatorFactor
     /**
      * Set the headers passed to the gateway for authentication.
      * 
-     * @param outboundHeaders Set<String>
      */
     public void setOutboundHeaders(Set<String> outboundHeaders)
     {

source/java/org/alfresco/rest/framework/core/ResourceInspector.java

@@ -183,9 +183,7 @@ public class ResourceInspector
     /**
      * Inspects the entity resource and returns meta data about any addresssed/binary properties
      * @param api Api
-     * @param resource Class<?>
      * @param entityPath String
-     * @param metainfo List<ResourceMetadata>
      */
     public static void inspectAddressedProperties(Api api, Class<?> resource, final String entityPath, List<ResourceMetadata> metainfo)
     {
@@ -320,7 +318,6 @@ public class ResourceInspector
 
     /**
      * Inspects the method and returns meta data about its operations
-     * @param resource Class<?>
      * @param aMethod Method
      * @param httpMethod HttpMethod
      * @return ResourceOperation
@@ -548,8 +545,6 @@ public class ResourceInspector
     
     /**
      * Returns the method for the interface
-     * @param resourceInterfaceWithOneMethod Class<? extends ResourceAction>
-     * @param resource Class<?>
      * @return null or a Method
      */
     public static Method findMethod(Class<? extends ResourceAction> resourceInterfaceWithOneMethod, Class<?> resource)
@@ -566,7 +561,6 @@ public class ResourceInspector
     
     /**
      * Finds the name of the entity using its annotation.
-     * @param annotAttribs Map<String, Object>
      * @return the entity name/path
      */
     protected static String findEntityNameByAnnotationAttributes(Map<String, Object> annotAttribs)
@@ -616,7 +610,6 @@ public class ResourceInspector
     /**
      * For a given class, looks for @EmbeddedEntityResource annotations, using the annotation produce
      * a Map of the property name key and the entity key
-     * @param anyClass Class<?>
      * @return A map of property key name and a value of the entity path name
      */
     public static Map<String,Pair<String,Method>> findEmbeddedResources(Class<?> anyClass)
@@ -644,9 +637,7 @@ public class ResourceInspector
     /**
      * Inspect a resource to find operations on it.
      * @param api Api
-     * @param resource Class<?>
      * @param entityPath String
-     * @param metainfo List<ResourceMetadata>
      */
     public static void inspectOperations(Api api, Class<?> resource, final String entityPath, List<ResourceMetadata> metainfo)
     {
@@ -698,7 +689,6 @@ public class ResourceInspector
      * Inspects the resource to determine what api it belongs to.
      * It does this by looking for the WebApi package annotation.
      * 
-     * @param resource Class<?>
      * @return Api
      */
     public static Api inspectApi(Class<?> resource)

source/java/org/alfresco/rest/framework/core/ResourceMetadata.java

@@ -104,7 +104,6 @@ public class ResourceMetadata
 
     /**
      * Indicates if this resource action is no longer supported.
-     * @param resourceAction Class<? extends ResourceAction>
      * @return true if it is no longer supported
      */
     public boolean isDeleted(Class<? extends ResourceAction> resourceAction)

source/java/org/alfresco/rest/framework/core/ResourceOperation.java

@@ -47,7 +47,6 @@ public class ResourceOperation
      * @param httpMethod HttpMethod
      * @param title String
      * @param description String
-     * @param parameters List<ResourceParameter>
      * @param successStatus HTTP status
      */
     public ResourceOperation(HttpMethod httpMethod, String title, String description, List<ResourceParameter> parameters, int successStatus)

source/java/org/alfresco/rest/framework/jacksonextensions/JacksonHelper.java

@@ -123,7 +123,6 @@ public class JacksonHelper implements InitializingBean
     /**
      * Constructs the object based on the content.
      * @param content Reader
-     * @param requiredType Class<T>
      * @return T
      * @throws IOException
      */
@@ -143,7 +142,6 @@ public class JacksonHelper implements InitializingBean
     /**
      * Constructs the object based on the content as a List, the JSON can be an array or just a single value without the [] symbols
      * @param content Reader
-     * @param requiredType Class<T>
      * @return A collection of the specified type
      * @throws IOException
      */

source/java/org/alfresco/rest/framework/resource/actions/interfaces/EntityResourceAction.java

@@ -71,7 +71,6 @@ public interface EntityResourceAction
          * 
          * Paging information is provided.
          * @param params - will never be null and will have the PAGING default values
-         * @return CollectionWithPagingInfo<E>
          */
         public CollectionWithPagingInfo<E> readAll (Parameters params);
     }
@@ -87,7 +86,6 @@ public interface EntityResourceAction
          *
          * Paging information is provided.
          * @param params - will never be null and will have the PAGING default values
-         * @return CollectionWithPagingInfo<E>
          */
         public CollectionWithPagingInfo<E> readAll (Parameters params, WithResponse withResponse);
     }

source/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java

@@ -52,7 +52,6 @@ public interface RelationshipResourceAction
          * Paging information is provided.  
          * @param entityResourceId Entity resource context for this relationship
          * @param params - will never be null and will have the PAGING default values
-         * @return CollectionWithPagingInfo<E>
          */
         public CollectionWithPagingInfo<E> readAll (String entityResourceId, Parameters params);
     }
@@ -68,7 +67,6 @@ public interface RelationshipResourceAction
          * Paging information is provided.
          * @param entityResourceId Entity resource context for this relationship
          * @param params - will never be null and will have the PAGING default values
-         * @return CollectionWithPagingInfo<E>
          */
         public CollectionWithPagingInfo<E> readAll (String entityResourceId, Parameters params, WithResponse withResponse);
     }

source/java/org/alfresco/rest/framework/resource/parameters/Parameters.java

@@ -116,7 +116,6 @@ public interface Parameters
     /**
      * A list of property names passed in the request using the json pointer syntax
      * Specified by the "SELECT" request parameter.
-     * @return List<String> the propertyNames
      */
     @Deprecated
     List<String> getSelectedProperties();
@@ -124,7 +123,7 @@ public interface Parameters
     /**
      * A list of property names passed in the request using the json pointer syntax
      * Specified by the "INCLUDE" request parameter.
-     * @return List<String> the propertyNames
+     * @return the propertyNames
      */
     List<String> getInclude();
 

source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java

@@ -239,7 +239,7 @@ public class ResourceWebScriptHelper
     /**
      * Takes the "select" parameter and turns it into a List<String> property names
      * @param selectParam String
-     * @return List<String> bean property names potentially using JSON Pointer syntax
+     * @return bean property names potentially using JSON Pointer syntax
      */
     @SuppressWarnings("unchecked")
     @Deprecated
@@ -251,7 +251,7 @@ public class ResourceWebScriptHelper
     /**
      * Takes the "include" parameter and turns it into a List<String> property names
      * @param includeParam String
-     * @return List<String> bean property names potentially using JSON Pointer syntax
+     * @return bean property names potentially using JSON Pointer syntax
      */
     @SuppressWarnings("unchecked")
     public static List<String> getIncludeClause(String includeParam) throws InvalidArgumentException
@@ -334,7 +334,7 @@ public class ResourceWebScriptHelper
      * e.g. "name DESC, age ASC".  It is not case sensitive and the sort direction is optional
      * It default to sort ASCENDING.
      * @param sortParams - String passed in on the request
-     * @return List<SortColumn> - the sort columns or an empty list if the params were invalid.
+     * @return - the sort columns or an empty list if the params were invalid.
      */
     public static List<SortColumn> getSort(String sortParams)
     {

source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java

@@ -122,7 +122,6 @@ public class WebScriptOptionsMetaData extends ApiWebScript implements ResourceMe
     /**
      * Processes the resulting resource and returns the data to be displayed
      * @param resource ResourceWithMetadata
-     * @param apiResources Map<String, ResourceWithMetadata>
      * @return Either a ExecutionResult or a CollectionWithPagingInfo
      */
     public static Object processResult(ResourceWithMetadata resource, Map<String, ResourceWithMetadata> apiResources)