This is an automated email from the ASF dual-hosted git repository. rfscholte pushed a commit to branch MJAVADOC-660 in repository https://gitbox.apache.org/repos/asf/maven-javadoc-plugin.git
commit 0fa686598d77a962b87d237a25394f89bc7bc04a Author: Michael Boyles <[email protected]> AuthorDate: Thu Sep 24 12:37:44 2020 +0100 - No periods without complete sentences in @param fixes --- .../plugins/javadoc/AbstractFixJavadocMojo.java | 8 ++-- .../src/main/java/fix/test/ClassWithJavadoc.java | 50 +++++++++++----------- .../src/main/java/fix/test/ClassWithNoJavadoc.java | 34 +++++++-------- .../main/java/fix/test/InterfaceWithJavadoc.java | 16 +++---- .../main/java/fix/test/InterfaceWithNoJavadoc.java | 8 ++-- .../src/main/java/fix/test/ClassWithJavadoc.java | 10 ++--- 6 files changed, 63 insertions(+), 63 deletions(-) diff --git a/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java b/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java index 8d712a2..1d98ada 100644 --- a/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java +++ b/src/main/java/org/apache/maven/plugins/javadoc/AbstractFixJavadocMojo.java @@ -2734,7 +2734,7 @@ public abstract class AbstractFixJavadocMojo { sb.append( "a " ).append( clazz.getCanonicalName() ); } - return sb.append( "." ).toString(); + return sb.toString(); } StringBuilder javadocLink = new StringBuilder(); @@ -2761,11 +2761,11 @@ public abstract class AbstractFixJavadocMojo if ( clazz.isArray() ) { - sb.append( "an array of " ).append( javadocLink ).append( " objects." ); + sb.append( "an array of " ).append( javadocLink ).append( " objects" ); } else { - sb.append( "a " ).append( javadocLink ).append( " object." ); + sb.append( "a " ).append( javadocLink ).append( " object" ); } return sb.toString(); @@ -2773,7 +2773,7 @@ public abstract class AbstractFixJavadocMojo private String getDefaultJavadocForType( JavaTypeVariable<JavaGenericDeclaration> typeParameter ) { - return "a " + typeParameter.getName() + " class."; + return "a " + typeParameter.getName() + " class"; } /** diff --git a/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java b/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java index c030553..174992f 100644 --- a/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java +++ b/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java @@ -39,7 +39,7 @@ public class ClassWithJavadoc /** * <p>Constructor for ClassWithJavadoc.</p> * - * @param aString a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object */ public ClassWithJavadoc( String aString ) { @@ -48,7 +48,7 @@ public class ClassWithJavadoc /** * public constructor with annotation * - * @param b a {@link java.lang.Boolean} object. + * @param b a {@link java.lang.Boolean} object * @since 1.1 */ @SuppressWarnings("SameReturnValue") @@ -76,10 +76,10 @@ public class ClassWithJavadoc /** * <p>missingJavadocTags.</p> * - * @param str a {@link java.lang.String} object. - * @param b a boolean. - * @param i a int. - * @return a {@link java.lang.String} object. + * @param str a {@link java.lang.String} object + * @param b a boolean + * @param i a int + * @return a {@link java.lang.String} object */ public String missingJavadocTags( String str, boolean b, int i ) { @@ -89,11 +89,11 @@ public class ClassWithJavadoc /** * <p>missingJavadocTags2.</p> * - * @param str a {@link java.lang.String} object. + * @param str a {@link java.lang.String} object * @throws java.lang.UnsupportedOperationException if any - * @param b a boolean. - * @param i a int. - * @return a {@link java.lang.String} object. + * @param b a boolean + * @param i a int + * @return a {@link java.lang.String} object */ public String missingJavadocTags2( String str, boolean b, int i ) throws UnsupportedOperationException @@ -104,7 +104,7 @@ public class ClassWithJavadoc /** * <p>wrongJavadocTag.</p> * - * @param aString a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object */ public void wrongJavadocTag( String aString ) { @@ -148,8 +148,8 @@ public class ClassWithJavadoc /** * To take care of single comments. * - * @param aString a {@link java.lang.String} object. - * @return a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object + * @return a {@link java.lang.String} object */ // other single comment public String singleComments( String aString ) @@ -172,7 +172,7 @@ public class ClassWithJavadoc * Empty Javadoc tag. * * @return a string - * @param aString a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object */ public String emptyJavadocTag( String aString ) { @@ -231,8 +231,8 @@ public class ClassWithJavadoc /** * New class method to be found by Clirr. * - * @param aString a {@link java.lang.String} object. - * @return a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object + * @return a {@link java.lang.String} object * @since 1.1 */ public String newClassMethod( String aString ) @@ -362,9 +362,9 @@ public class ClassWithJavadoc /** * test generic function (with only head javadoc) * - * @param tClass a {@link java.lang.Class} object. - * @param o a {@link java.lang.Object} object. - * @param <T> a T class. + * @param tClass a {@link java.lang.Class} object + * @param o a {@link java.lang.Object} object + * @param <T> a T class * @since 1.1 */ public <T extends Object> void testGeneric0(Class<T> tClass, Object o) @@ -375,9 +375,9 @@ public class ClassWithJavadoc /** * test generic function (with full javadoc) * - * @param tClass a {@link java.lang.Class} object. - * @param o a {@link java.lang.Object} object. - * @param <T> a T class. + * @param tClass this comment should be preserved + * @param o this comment should be preserved + * @param <T> this comment should be preserved * @since 1.1 */ public <T extends Object> void testGeneric1(Class<T> tClass, Object o) @@ -388,9 +388,9 @@ public class ClassWithJavadoc /** * test generic function (with full javadoc, except generic docs) * - * @param tClass a {@link java.lang.Class} object. - * @param o a {@link java.lang.Object} object. - * @param <T> a T class. + * @param tClass this comment should be preserved + * @param o this comment should be preserved + * @param <T> a T class * @since 1.1 */ public <T extends Object> void testGeneric2(Class<T> tClass, Object o) diff --git a/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java b/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java index ce6db45..e2ff6a9 100644 --- a/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java +++ b/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java @@ -64,7 +64,7 @@ public class ClassWithNoJavadoc /** * <p>Constructor for ClassWithNoJavadoc.</p> * - * @param aString a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object */ public ClassWithNoJavadoc( String aString ) { @@ -74,7 +74,7 @@ public class ClassWithNoJavadoc /** * <p>Constructor for ClassWithNoJavadoc.</p> * - * @param b a {@link java.lang.Boolean} object. + * @param b a {@link java.lang.Boolean} object * @since 1.1 */ public ClassWithNoJavadoc( Boolean b ) @@ -90,14 +90,14 @@ public class ClassWithNoJavadoc /** * <p>missingJavadocTagsForPrimitives.</p> * - * @param i a int. - * @param b a byte. - * @param f a float. - * @param c a char. - * @param s a short. - * @param l a long. - * @param d a double. - * @param bb a boolean. + * @param i a int + * @param b a byte + * @param f a float + * @param c a char + * @param s a short + * @param l a long + * @param d a double + * @param bb a boolean */ public void missingJavadocTagsForPrimitives( int i, byte b, float f, char c, short s, long l, double d, boolean bb ) { @@ -107,8 +107,8 @@ public class ClassWithNoJavadoc /** * <p>missingJavadocTagsForObjects.</p> * - * @param s a {@link java.lang.String} object. - * @param m a {@link java.util.Map} object. + * @param s a {@link java.lang.String} object + * @param m a {@link java.util.Map} object */ public void missingJavadocTagsForObjects( String s, Map m ) { @@ -126,8 +126,8 @@ public class ClassWithNoJavadoc /** * <p>newClassMethod.</p> * - * @param aString a {@link java.lang.String} object. - * @return a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object + * @return a {@link java.lang.String} object * @since 1.1 */ public String newClassMethod( String aString ) @@ -209,9 +209,9 @@ public class ClassWithNoJavadoc /** * <p>testGeneric3.</p> * - * @param tClass a {@link java.lang.Class} object. - * @param o a {@link java.lang.Object} object. - * @param <T> a T class. + * @param tClass a {@link java.lang.Class} object + * @param o a {@link java.lang.Object} object + * @param <T> a T class * @since 1.1 */ public <T extends Object> void testGeneric3(Class<T> tClass, Object o) diff --git a/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java b/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java index c93b2a5..89bdf06 100644 --- a/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java +++ b/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java @@ -33,14 +33,14 @@ public interface InterfaceWithJavadoc /** * To add default method tags. * - * @param aString a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object */ public void method1( String aString ); /** * To take care of identifier. * - * @param aString a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object */ void method2( String aString ); @@ -57,16 +57,16 @@ public interface InterfaceWithJavadoc /** * Nothing. * - * @param aString a {@link java.lang.String} object. - * @return a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object + * @return a {@link java.lang.String} object */ public String method4( String aString ); /** * Nothing. * - * @param aString a {@link java.lang.String} object. - * @return a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object + * @return a {@link java.lang.String} object */ public String method5( String aString ); @@ -77,8 +77,8 @@ public interface InterfaceWithJavadoc /** * New interface method to be found by Clirr. * - * @param aString a {@link java.lang.String} object. - * @return a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object + * @return a {@link java.lang.String} object * @since 1.1 */ public String newInterfaceMethod( String aString ); diff --git a/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java b/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java index 3f7aab9..0ec11c0 100644 --- a/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java +++ b/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java @@ -33,7 +33,7 @@ public interface InterfaceWithNoJavadoc /** * <p>missingJavadoc.</p> * - * @param aString a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object */ public void missingJavadoc( String aString ); @@ -41,7 +41,7 @@ public interface InterfaceWithNoJavadoc /** * <p>missingJavadoc2.</p> * - * @param aString a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object */ void missingJavadoc2( String aString ); @@ -52,8 +52,8 @@ public interface InterfaceWithNoJavadoc /** * <p>newInterfaceMethod.</p> * - * @param aString a {@link java.lang.String} object. - * @return a {@link java.lang.String} object. + * @param aString a {@link java.lang.String} object + * @return a {@link java.lang.String} object * @since 1.1 */ public String newInterfaceMethod( String aString ); diff --git a/src/test/resources/unit/fix-test/src/main/java/fix/test/ClassWithJavadoc.java b/src/test/resources/unit/fix-test/src/main/java/fix/test/ClassWithJavadoc.java index cb05cc9..f5c2f96 100644 --- a/src/test/resources/unit/fix-test/src/main/java/fix/test/ClassWithJavadoc.java +++ b/src/test/resources/unit/fix-test/src/main/java/fix/test/ClassWithJavadoc.java @@ -347,9 +347,9 @@ public class ClassWithJavadoc /** * test generic function (with full javadoc) * - * @param tClass a {@link java.lang.Class} object. - * @param o a {@link java.lang.Object} object. - * @param <T> a T class. + * @param tClass this comment should be preserved + * @param o this comment should be preserved + * @param <T> this comment should be preserved */ public <T extends Object> void testGeneric1(Class<T> tClass, Object o) { @@ -359,8 +359,8 @@ public class ClassWithJavadoc /** * test generic function (with full javadoc, except generic docs) * - * @param tClass a {@link java.lang.Class} object. - * @param o a {@link java.lang.Object} object. + * @param tClass this comment should be preserved + * @param o this comment should be preserved */ public <T extends Object> void testGeneric2(Class<T> tClass, Object o) {
