From 423e98641ca7fe79a1b1bb897aa8a4b17ba5ee4d Mon Sep 17 00:00:00 2001 From: liamfallon Date: Fri, 28 Jun 2019 10:42:34 +0000 Subject: Replace non-Javadoc comments with inheritDocs Copyright headers not changed as this review only amends comments. Issue-ID: POLICY-1791 Change-Id: Icbeb2c6e591b3b160ae102bb67aef2d407924a4d Signed-off-by: liamfallon --- .../apex/auth/clicodegen/CgStringRenderer.java | 7 ++----- .../apex/auth/clicodegen/DummyStErrorListener.java | 16 ++++++++-------- .../apex/auth/clieditor/ApexModelProperties.java | 6 ++---- .../apex/auth/clieditor/CommandLineArgument.java | 20 ++++++++------------ .../auth/clieditor/CommandLineArgumentValue.java | 6 ++---- .../apex/auth/clieditor/CommandLineCommand.java | 20 ++++++++------------ .../apex/auth/clieditor/CommandLineParameters.java | 6 ++---- .../onap/policy/apex/auth/clieditor/KeywordNode.java | 12 ++++-------- 8 files changed, 36 insertions(+), 57 deletions(-) (limited to 'auth') diff --git a/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java b/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java index dbf8f3844..f17ac6a1e 100644 --- a/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java +++ b/auth/cli-codegen/src/main/java/org/onap/policy/apex/auth/clicodegen/CgStringRenderer.java @@ -33,11 +33,8 @@ import org.stringtemplate.v4.StringRenderer; */ public class CgStringRenderer implements AttributeRenderer { - /* - * (non-Javadoc) - * - * @see org.stringtemplate.v4.AttributeRenderer#toString(java.lang.Object, java.lang.String, - * java.util.Locale) + /** + * {@inheritDoc}. */ @Override public String toString(final Object obj, final String format, final Locale locale) { diff --git a/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/DummyStErrorListener.java b/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/DummyStErrorListener.java index 33387accc..45d307b47 100644 --- a/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/DummyStErrorListener.java +++ b/auth/cli-codegen/src/test/java/org/onap/policy/apex/auth/clicodegen/DummyStErrorListener.java @@ -33,8 +33,8 @@ public class DummyStErrorListener implements STErrorListener { /** Counts errors of the listener. */ private int errorCount; - /* (non-Javadoc) - * @see org.stringtemplate.v4.STErrorListener#IOError(org.stringtemplate.v4.misc.STMessage) + /** + * {@inheritDoc}. */ @Override public void IOError(final STMessage msg) { @@ -44,8 +44,8 @@ public class DummyStErrorListener implements STErrorListener { } } - /* (non-Javadoc) - * @see org.stringtemplate.v4.STErrorListener#compileTimeError(org.stringtemplate.v4.misc.STMessage) + /** + * {@inheritDoc}. */ @Override public void compileTimeError(final STMessage msg) { @@ -55,8 +55,8 @@ public class DummyStErrorListener implements STErrorListener { } } - /* (non-Javadoc) - * @see org.stringtemplate.v4.STErrorListener#internalError(org.stringtemplate.v4.misc.STMessage) + /** + * {@inheritDoc}. */ @Override public void internalError(final STMessage msg) { @@ -66,8 +66,8 @@ public class DummyStErrorListener implements STErrorListener { } } - /* (non-Javadoc) - * @see org.stringtemplate.v4.STErrorListener#runTimeError(org.stringtemplate.v4.misc.STMessage) + /** + * {@inheritDoc}. */ @Override public void runTimeError(final STMessage msg) { diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexModelProperties.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexModelProperties.java index 6ed68288a..0e3cd0634 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexModelProperties.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/ApexModelProperties.java @@ -199,10 +199,8 @@ public class ApexModelProperties { return defaultMacroFileTag; } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgument.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgument.java index 6ce1979b2..48899baa6 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgument.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgument.java @@ -105,10 +105,8 @@ public class CommandLineArgument implements Comparable { return builder.toString(); } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -116,10 +114,8 @@ public class CommandLineArgument implements Comparable { + "]"; } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final CommandLineArgument otherArgument) { @@ -143,8 +139,8 @@ public class CommandLineArgument implements Comparable { return description.compareTo(otherArgument.description); } - /* (non-Javadoc) - * @see java.lang.Object#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -156,8 +152,8 @@ public class CommandLineArgument implements Comparable { return result; } - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(Object obj) { diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgumentValue.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgumentValue.java index 64059e31b..732f88c8e 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgumentValue.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineArgumentValue.java @@ -79,10 +79,8 @@ public class CommandLineArgumentValue { specified = true; } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineCommand.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineCommand.java index 564c5320a..38ff98010 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineCommand.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineCommand.java @@ -187,10 +187,8 @@ public class CommandLineCommand implements Comparable { return builder.toString(); } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -199,10 +197,8 @@ public class CommandLineCommand implements Comparable { + "]"; } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final CommandLineCommand otherCommand) { @@ -255,8 +251,8 @@ public class CommandLineCommand implements Comparable { return 0; } - /* (non-Javadoc) - * @see java.lang.Object#hashCode() + /** + * {@inheritDoc}. */ @Override public int hashCode() { @@ -271,8 +267,8 @@ public class CommandLineCommand implements Comparable { return result; } - /* (non-Javadoc) - * @see java.lang.Object#equals(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public boolean equals(Object obj) { diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameters.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameters.java index 9a03dcfde..036208fd2 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameters.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/CommandLineParameters.java @@ -560,10 +560,8 @@ public class CommandLineParameters { this.ignoreCommandFailures = ignoreCommandFailures; } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { diff --git a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/KeywordNode.java b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/KeywordNode.java index f6932e993..4fe67b357 100644 --- a/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/KeywordNode.java +++ b/auth/cli-editor/src/main/java/org/onap/policy/apex/auth/clieditor/KeywordNode.java @@ -133,10 +133,8 @@ public class KeywordNode implements Comparable { return command; } - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() + /** + * {@inheritDoc}. */ @Override public String toString() { @@ -161,10 +159,8 @@ public class KeywordNode implements Comparable { return commandSet; } - /* - * (non-Javadoc) - * - * @see java.lang.Comparable#compareTo(java.lang.Object) + /** + * {@inheritDoc}. */ @Override public int compareTo(final KeywordNode otherKeywordNode) { -- cgit 1.2.3-korg