[OLINGO-468] Fixed javadoc warning in lib
Project: http://git-wip-us.apache.org/repos/asf/olingo-odata4/repo Commit: http://git-wip-us.apache.org/repos/asf/olingo-odata4/commit/58b3896f Tree: http://git-wip-us.apache.org/repos/asf/olingo-odata4/tree/58b3896f Diff: http://git-wip-us.apache.org/repos/asf/olingo-odata4/diff/58b3896f Branch: refs/heads/master Commit: 58b3896f7dd6e9d9a369294b95b553d4daa3d57a Parents: 47c1851 Author: Michael Bolz <[email protected]> Authored: Tue Dec 16 11:08:15 2014 +0100 Committer: Michael Bolz <[email protected]> Committed: Tue Dec 16 14:26:41 2014 +0100 ---------------------------------------------------------------------- .../api/communication/header/HeaderName.java | 2 -- .../api/communication/request/ODataRequest.java | 1 - .../request/v4/AsyncRequestWrapper.java | 2 +- .../batch/AbstractODataBatchRequestItem.java | 1 - .../olingo/client/core/uri/ParameterAlias.java | 2 +- .../server/core/uri/parser/UriContext.java | 21 ++++++++++++++------ 6 files changed, 17 insertions(+), 12 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/58b3896f/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/header/HeaderName.java ---------------------------------------------------------------------- diff --git a/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/header/HeaderName.java b/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/header/HeaderName.java index 5af99e7..e741d60 100644 --- a/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/header/HeaderName.java +++ b/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/header/HeaderName.java @@ -153,8 +153,6 @@ public enum HeaderName { * request), and a server MAY honor the header for HTTP POST, PUT, PATCH, and MERGE requests. A Prefer header with a * value of âreturn-contentâ MUST NOT be specified on a DELETE request, a batch request as a whole, or a PUT request * to update a named stream. - * - * @see ODataPreferenceNames. */ prefer("Prefer", Arrays.asList(ODataServiceVersion.V30, ODataServiceVersion.V40)), /** http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/58b3896f/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/ODataRequest.java ---------------------------------------------------------------------- diff --git a/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/ODataRequest.java b/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/ODataRequest.java index 2c638cf..7a15320 100644 --- a/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/ODataRequest.java +++ b/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/ODataRequest.java @@ -33,7 +33,6 @@ import org.apache.olingo.commons.api.http.HttpMethod; * @see org.apache.olingo.client.api.communication.request.batch.v3.BatchRequestFactory * @see org.apache.olingo.client.api.communication.request.batch.v4.BatchRequestFactory * @see org.apache.olingo.client.api.communication.request.invoke.InvokeRequestFactory - * @see org.apache.olingo.client.api.communication.request.streamed.StreamedRequestFactory */ public interface ODataRequest { http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/58b3896f/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/v4/AsyncRequestWrapper.java ---------------------------------------------------------------------- diff --git a/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/v4/AsyncRequestWrapper.java b/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/v4/AsyncRequestWrapper.java index 812f08d..220e063 100644 --- a/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/v4/AsyncRequestWrapper.java +++ b/lib/client-api/src/main/java/org/apache/olingo/client/api/communication/request/v4/AsyncRequestWrapper.java @@ -50,7 +50,7 @@ public interface AsyncRequestWrapper<R extends ODataResponse> { /** * execute the request for the first time. * - * @return + * @return the current AsyncRequestWrapper instance. */ AsyncResponseWrapper<R> execute(); } http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/58b3896f/lib/client-core/src/main/java/org/apache/olingo/client/core/communication/request/batch/AbstractODataBatchRequestItem.java ---------------------------------------------------------------------- diff --git a/lib/client-core/src/main/java/org/apache/olingo/client/core/communication/request/batch/AbstractODataBatchRequestItem.java b/lib/client-core/src/main/java/org/apache/olingo/client/core/communication/request/batch/AbstractODataBatchRequestItem.java index 251d161..4d3a8aa 100644 --- a/lib/client-core/src/main/java/org/apache/olingo/client/core/communication/request/batch/AbstractODataBatchRequestItem.java +++ b/lib/client-core/src/main/java/org/apache/olingo/client/core/communication/request/batch/AbstractODataBatchRequestItem.java @@ -78,7 +78,6 @@ public abstract class AbstractODataBatchRequestItem extends AbstractODataStreame * <p> * Use this method to stream changeset items. * - * @param request request to be batched. * @param contentId changeset item id. */ protected void streamRequestHeader(final String contentId) { http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/58b3896f/lib/client-core/src/main/java/org/apache/olingo/client/core/uri/ParameterAlias.java ---------------------------------------------------------------------- diff --git a/lib/client-core/src/main/java/org/apache/olingo/client/core/uri/ParameterAlias.java b/lib/client-core/src/main/java/org/apache/olingo/client/core/uri/ParameterAlias.java index dd3d67b..8b04157 100644 --- a/lib/client-core/src/main/java/org/apache/olingo/client/core/uri/ParameterAlias.java +++ b/lib/client-core/src/main/java/org/apache/olingo/client/core/uri/ParameterAlias.java @@ -40,7 +40,7 @@ public class ParameterAlias { /** * Gets parameter alias. * - * @return + * @return parameter alias */ public String getAlias() { return alias; http://git-wip-us.apache.org/repos/asf/olingo-odata4/blob/58b3896f/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/UriContext.java ---------------------------------------------------------------------- diff --git a/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/UriContext.java b/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/UriContext.java index eb6f16a..b99433d 100644 --- a/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/UriContext.java +++ b/lib/server-core/src/main/java/org/apache/olingo/server/core/uri/parser/UriContext.java @@ -26,6 +26,10 @@ import org.apache.olingo.server.core.uri.queryoption.SelectItemImpl; import java.util.Stack; +/** + * UriContext object used for holding information for URI parsing. + * + */ public class UriContext { public static class LambdaVariables { @@ -48,11 +52,14 @@ public class UriContext { // CHECKSTYLE:OFF (Maven checkstyle) /** * Set within method - * {@link #visitExpandItem(org.apache.olingo.server.core.uri.antlr.UriParserParser.ExpandPathContext ctx)} and {@link - * #visitExpandPathExtension(final - * ExpandPathExtensionContext ctx)} to allow nodes + * {@link org.apache.olingo.server.core.uri.antlr.UriParserBaseVisitor#visitExpandItem( + * org.apache.olingo.server.core.uri.antlr.UriParserParser.ExpandItemContext ctx)} + * and {@link + * org.apache.olingo.server.core.uri.antlr.UriParserBaseVisitor#visitExpandPathExtension( + * org.apache.olingo.server.core.uri.antlr.UriParserParser.ExpandPathExtensionContext ctx)} to allow nodes * deeper in the expand tree at - * {@link #visitExpandPathExtension (org.apache.olingo.server.core.uri.antlr.UriParserParser.ExpandPathExtensionContext ctx)} + * {@link org.apache.olingo.server.core.uri.antlr.UriParserBaseVisitor#visitExpandPathExtension( + * org.apache.olingo.server.core.uri.antlr.UriParserParser.ExpandPathExtensionContext ctx)} * appending path * segments to the currently processed {@link ExpandItemImpl}. */ @@ -61,10 +68,12 @@ public class UriContext { /** * Set within method - * {@link #visitSelectItem(org.apache.olingo.server.core.uri.antlr.UriParserParser.SelectItemContext ctx)} to allow + * {@link org.apache.olingo.server.core.uri.antlr.UriParserBaseVisitor#visitSelectItem( + * org.apache.olingo.server.core.uri.antlr.UriParserParser.SelectItemContext ctx)} to allow * nodes * deeper in the expand tree at - * {@link #visitSelectSegment(org.apache.olingo.server.core.uri.antlr.UriParserParser.SelectSegmentContext ctx)} + * {@link org.apache.olingo.server.core.uri.antlr.UriParserBaseVisitor#visitSelectSegment( + * org.apache.olingo.server.core.uri.antlr.UriParserParser.SelectSegmentContext ctx)} * appending path segments to the * currently processed {@link SelectItemImpl}. */
