From e39e468fffa2acd8b4302131c5946b0c2b908fba Mon Sep 17 00:00:00 2001 From: Martin Muller Date: Fri, 1 Jul 2016 08:34:26 +0000 Subject: [PATCH] Fixed some javadoc errors. REPO-466 git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@128510 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261 --- .../scripts/archive/AbstractArchivedNodeWebScript.java | 3 +-- .../repo/web/scripts/archive/ArchivedNodesGet.java | 1 - .../repo/web/scripts/content/ContentStreamer.java | 1 - .../repo/web/scripts/content/MimetypesGet.java | 3 +-- .../web/scripts/discussion/ForumTopicsFilteredGet.java | 2 -- .../org/alfresco/repo/web/scripts/solr/StatsGet.java | 1 - source/java/org/alfresco/repo/webdav/LockInfoImpl.java | 2 -- source/java/org/alfresco/repo/webdav/WebDAV.java | 1 - source/java/org/alfresco/repo/webdav/WebDAVHelper.java | 2 +- .../rest/api/PublicApiAuthenticatorFactory.java | 1 - .../rest/framework/core/ResourceInspector.java | 10 ---------- .../alfresco/rest/framework/core/ResourceMetadata.java | 1 - .../rest/framework/core/ResourceOperation.java | 1 - .../framework/jacksonextensions/JacksonHelper.java | 2 -- .../actions/interfaces/EntityResourceAction.java | 2 -- .../actions/interfaces/RelationshipResourceAction.java | 2 -- .../rest/framework/resource/parameters/Parameters.java | 3 +-- .../framework/webscripts/ResourceWebScriptHelper.java | 6 +++--- .../webscripts/metadata/WebScriptOptionsMetaData.java | 1 - 19 files changed, 7 insertions(+), 38 deletions(-) diff --git a/source/java/org/alfresco/repo/web/scripts/archive/AbstractArchivedNodeWebScript.java b/source/java/org/alfresco/repo/web/scripts/archive/AbstractArchivedNodeWebScript.java index 4df4cfe01d..c294dadbf3 100644 --- a/source/java/org/alfresco/repo/web/scripts/archive/AbstractArchivedNodeWebScript.java +++ b/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 */ protected PagingResults getArchivedNodesFrom(StoreRef storeRef, ScriptPagingDetails paging, String filter) { @@ -199,4 +198,4 @@ public abstract class AbstractArchivedNodeWebScript extends DeclarativeWebScript throw new WebScriptException(Status.STATUS_FORBIDDEN, "You don't have permission to act on the node."); } } -} \ No newline at end of file +} diff --git a/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java b/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java index 9881e4d757..437aa717ac 100644 --- a/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java +++ b/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 */ public void setArchivedNodeFilters(List nodeFilters) { diff --git a/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java b/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java index a3beaf4dc8..3991482802 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java +++ b/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 */ protected void setResponseCache(WebScriptResponse res, Date modified, String eTag, Map model) { diff --git a/source/java/org/alfresco/repo/web/scripts/content/MimetypesGet.java b/source/java/org/alfresco/repo/web/scripts/content/MimetypesGet.java index b031680bc7..4fc7183f9c 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/MimetypesGet.java +++ b/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 */ public void setKnownWorkerBeanLabels(Map knownWorkerBeanLabels) { @@ -305,4 +304,4 @@ public class MimetypesGet extends DeclarativeWebScript implements ApplicationCon return knownWorkers.get(ctw); } -} \ No newline at end of file +} diff --git a/source/java/org/alfresco/repo/web/scripts/discussion/ForumTopicsFilteredGet.java b/source/java/org/alfresco/repo/web/scripts/discussion/ForumTopicsFilteredGet.java index 21aa372d00..a4e9c40649 100644 --- a/source/java/org/alfresco/repo/web/scripts/discussion/ForumTopicsFilteredGet.java +++ b/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 */ protected PagingResults doSearch(Pair searchQuery, boolean sortAscending, PagingRequest paging) { @@ -317,7 +316,6 @@ public class ForumTopicsFilteredGet extends AbstractDiscussionWebScript * * @param finalResults ResultSet * @param paging PagingRequest - * @return PagingResults */ protected PagingResults wrap(final ResultSet finalResults, PagingRequest paging) { diff --git a/source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java b/source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java index 9e84bdb1f0..9dbce44358 100644 --- a/source/java/org/alfresco/repo/web/scripts/solr/StatsGet.java +++ b/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 */ public static Pair getStartAndEndDates(String start, String end) { diff --git a/source/java/org/alfresco/repo/webdav/LockInfoImpl.java b/source/java/org/alfresco/repo/webdav/LockInfoImpl.java index 5f151d0a03..a1cced3f74 100644 --- a/source/java/org/alfresco/repo/webdav/LockInfoImpl.java +++ b/source/java/org/alfresco/repo/webdav/LockInfoImpl.java @@ -176,7 +176,6 @@ public class LockInfoImpl implements Serializable, LockInfo /** * Getter for sharedLockTokens list. * - * @return LinkedList */ @Override public Set getSharedLockTokens() @@ -187,7 +186,6 @@ public class LockInfoImpl implements Serializable, LockInfo /** * Setter for sharedLockTokens list. * - * @param sharedLockTokens Set */ @Override public void setSharedLockTokens(Set sharedLockTokens) diff --git a/source/java/org/alfresco/repo/webdav/WebDAV.java b/source/java/org/alfresco/repo/webdav/WebDAV.java index 72868a1386..9f41a0f40c 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAV.java +++ b/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 * @param davPropName String * @return Object */ diff --git a/source/java/org/alfresco/repo/webdav/WebDAVHelper.java b/source/java/org/alfresco/repo/webdav/WebDAVHelper.java index 393aa4a031..41c68ef110 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVHelper.java +++ b/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. *

- * + * ALF-3856, ALF-7079, MNT-181 * * @param renameShufflePattern a regular expression filename match */ diff --git a/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java b/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java index e63bd71e1f..0b18efa24a 100644 --- a/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java +++ b/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 */ public void setOutboundHeaders(Set outboundHeaders) { diff --git a/source/java/org/alfresco/rest/framework/core/ResourceInspector.java b/source/java/org/alfresco/rest/framework/core/ResourceInspector.java index 0b57e0c4fd..8fde2e6ec6 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceInspector.java +++ b/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 */ public static void inspectAddressedProperties(Api api, Class resource, final String entityPath, List 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 - * @param resource Class * @return null or a Method */ public static Method findMethod(Class resourceInterfaceWithOneMethod, Class resource) @@ -566,7 +561,6 @@ public class ResourceInspector /** * Finds the name of the entity using its annotation. - * @param annotAttribs Map * @return the entity name/path */ protected static String findEntityNameByAnnotationAttributes(Map 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> 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 */ public static void inspectOperations(Api api, Class resource, final String entityPath, List 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) diff --git a/source/java/org/alfresco/rest/framework/core/ResourceMetadata.java b/source/java/org/alfresco/rest/framework/core/ResourceMetadata.java index f00ff13683..3a008d5f6a 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceMetadata.java +++ b/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 * @return true if it is no longer supported */ public boolean isDeleted(Class resourceAction) diff --git a/source/java/org/alfresco/rest/framework/core/ResourceOperation.java b/source/java/org/alfresco/rest/framework/core/ResourceOperation.java index f4ea5be883..73726ea4e3 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceOperation.java +++ b/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 * @param successStatus HTTP status */ public ResourceOperation(HttpMethod httpMethod, String title, String description, List parameters, int successStatus) diff --git a/source/java/org/alfresco/rest/framework/jacksonextensions/JacksonHelper.java b/source/java/org/alfresco/rest/framework/jacksonextensions/JacksonHelper.java index ae9c6f2c96..bf7158d527 100644 --- a/source/java/org/alfresco/rest/framework/jacksonextensions/JacksonHelper.java +++ b/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 * @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 * @return A collection of the specified type * @throws IOException */ diff --git a/source/java/org/alfresco/rest/framework/resource/actions/interfaces/EntityResourceAction.java b/source/java/org/alfresco/rest/framework/resource/actions/interfaces/EntityResourceAction.java index 07f0445dcc..01fda88bd1 100644 --- a/source/java/org/alfresco/rest/framework/resource/actions/interfaces/EntityResourceAction.java +++ b/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 */ public CollectionWithPagingInfo 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 */ public CollectionWithPagingInfo readAll (Parameters params, WithResponse withResponse); } diff --git a/source/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java b/source/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java index 8e8cb49320..e0aaff0c1c 100644 --- a/source/java/org/alfresco/rest/framework/resource/actions/interfaces/RelationshipResourceAction.java +++ b/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 */ public CollectionWithPagingInfo 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 */ public CollectionWithPagingInfo readAll (String entityResourceId, Parameters params, WithResponse withResponse); } diff --git a/source/java/org/alfresco/rest/framework/resource/parameters/Parameters.java b/source/java/org/alfresco/rest/framework/resource/parameters/Parameters.java index 0166d1ceb9..fe949744c3 100644 --- a/source/java/org/alfresco/rest/framework/resource/parameters/Parameters.java +++ b/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 the propertyNames */ @Deprecated List 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 the propertyNames + * @return the propertyNames */ List getInclude(); diff --git a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java index 90c8b0f724..df1b194412 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java +++ b/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 property names * @param selectParam String - * @return List 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 property names * @param includeParam String - * @return List bean property names potentially using JSON Pointer syntax + * @return bean property names potentially using JSON Pointer syntax */ @SuppressWarnings("unchecked") public static List 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 - 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 getSort(String sortParams) { diff --git a/source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java b/source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java index 223d4cd44c..da94c26a12 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java +++ b/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 * @return Either a ExecutionResult or a CollectionWithPagingInfo */ public static Object processResult(ResourceWithMetadata resource, Map apiResources)