You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2009/07/08 17:59:36 UTC

svn commit: r792201 - in /maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected: ./ src/ src/main/ src/main/java/ src/main/java/fix/ src/main/java/fix/test/

Author: vsiveton
Date: Wed Jul  8 15:59:36 2009
New Revision: 792201

URL: http://svn.apache.org/viewvc?rev=792201&view=rev
Log:
o forgot test files for r792176

Added:
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java   (with props)
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java   (with props)
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java   (with props)
    maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java   (with props)

Added: maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java?rev=792201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java (added)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java Wed Jul  8 15:59:36 2009
@@ -0,0 +1,192 @@
+package fix.test;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * To add default class tags.
+ *
+ * @author Administrator
+ * @version $Id: $
+ * @since 1.0
+ */
+public class ClassWithJavadoc
+    implements InterfaceWithJavadoc
+{
+    /**
+     * Constructor comment.
+     */
+    public ClassWithJavadoc()
+    {
+    }
+
+    /**
+     * The main method
+     *
+     * @param args      an array of strings that contains the arguments
+     */
+    public void spacesInJavadocTags( String[] args )
+    {
+    }
+
+    /**
+     * <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.
+     */
+    public String missingJavadocTags( String str, boolean b, int i )
+    {
+        return null;
+    }
+
+    /**
+     * <p>missingJavadocTags2</p>
+     *
+     * @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.
+     */
+    public String missingJavadocTags2( String str, boolean b, int i )
+        throws UnsupportedOperationException
+    {
+        return null;
+    }
+
+    /**
+     * <p>wrongJavadocTag</p>
+     *
+     * @param aString a {@link java.lang.String} object.
+     */
+    public void wrongJavadocTag( String aString )
+    {
+    }
+
+    /**
+     * <p>multiLinesJavadocTags</p>
+     *
+     * @param aString
+     *      a string
+     * @param anotherString
+     *      with
+     *      multi
+     *      line
+     *      comments
+     * @return a
+     *      String
+     * @throws java.lang.UnsupportedOperationException
+     *      if any
+     */
+    public String multiLinesJavadocTags( String aString, String anotherString )
+        throws UnsupportedOperationException
+    {
+        return null;
+    }
+
+    /**
+     * To take care of the Javadoc indentation.
+     *
+     * @param aString a
+     *      String
+     * @return dummy
+     *      value
+     */
+    public String wrongJavadocIndentation( String aString )
+    {
+        return null;
+    }
+
+    // one single comment
+    /**
+     * To take care of single comments.
+     *
+     * @param aString a {@link java.lang.String} object.
+     * @return a {@link java.lang.String} object.
+     */
+    // other single comment
+    public String singleComments( String aString )
+    {
+        return null;
+    }
+
+    // ----------------------------------------------------------------------
+    // Inheritance
+    // ----------------------------------------------------------------------
+
+    /** {@inheritDoc} */
+    public void method1( String aString )
+    {
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * specific comment
+     */
+    public void method2( String aString )
+    {
+    }
+
+    /** {@inheritDoc} */
+    public String method3( String aString )
+    {
+        return null;
+    }
+
+    /** {@inheritDoc} */
+    public String method4( String aString )
+    {
+        return null;
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * Specific comment
+     */
+    public String method5( String aString )
+    {
+        return null;
+    }
+
+    // ----------------------------------------------------------------------
+    // Inner classes
+    // ----------------------------------------------------------------------
+
+    /**
+     * No javadoc for inner class.
+     */
+    public class InnerClass
+    {
+        /**
+         * constructor
+         */
+        public InnerClass()
+        {
+        }
+
+        public void nothing()
+        {
+        }
+    }
+}

Propchange: maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithJavadoc.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java?rev=792201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java (added)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java Wed Jul  8 15:59:36 2009
@@ -0,0 +1,107 @@
+package fix.test;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import java.util.Map;
+
+/**
+ * <p>ClassWithNoJavadoc class.</p>
+ *
+ * @author Administrator
+ * @version $Id: $
+ * @since 1.0
+ */
+public class ClassWithNoJavadoc
+{
+    /** Constant <code>MY_STRING_CONSTANT="value"</code> */
+    public static final String MY_STRING_CONSTANT = "value";
+
+    /** Constant <code>MY_STRING_CONSTANT2="default value"</code> */
+    public static final String MY_STRING_CONSTANT2 = "default" + " value";
+
+    /** Constant <code>MY_INT_CONSTANT=1</code> */
+    public static final int MY_INT_CONSTANT = 1;
+
+    /** Constant <code>EOL="System.getProperty( line.separator )"</code> */
+    public static final String EOL = System.getProperty( "line.separator" );
+
+    // take care of identifier
+    private static final String MY_PRIVATE_STRING_CONSTANT = "";
+
+    // QDOX-155
+    /** Constant <code>SEPARATOR=','</code> */
+    public static final char SEPARATOR = ',';
+
+    // QDOX-156
+    /** Constant <code>TEST1="test1"</code> */
+    public static final String TEST1 = "test1";
+
+    /**
+     * <p>Constructor for ClassWithNoJavadoc.</p>
+     */
+    public ClassWithNoJavadoc()
+    {
+    }
+
+    // take care of primitive
+    /**
+     * <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.
+     */
+    public void missingJavadocTagsForPrimitives( int i, byte b, float f, char c, short s, long l, double d, boolean bb )
+    {
+    }
+
+    // take care of object
+    /**
+     * <p>missingJavadocTagsForObjects</p>
+     *
+     * @param s a {@link java.lang.String} object.
+     * @param m a {@link java.util.Map} object.
+     */
+    public void missingJavadocTagsForObjects( String s, Map m )
+    {
+    }
+
+    // no Javadoc needed
+    private void privateMethod( String str )
+    {
+    }
+
+    //No javadoc for inner class.
+    public class InnerClass
+    {
+        public InnerClass()
+        {
+        }
+
+        public void nothing()
+        {
+        }
+    }
+}

Propchange: maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/ClassWithNoJavadoc.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java?rev=792201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java (added)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java Wed Jul  8 15:59:36 2009
@@ -0,0 +1,73 @@
+package fix.test;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * To add default interface tags.
+ *
+ * @author Administrator
+ * @version $Id: $
+ * @since 1.0
+ */
+public interface InterfaceWithJavadoc
+{
+    /** default comment */
+    String MY_STRING_CONSTANT = "value";
+
+    /**
+     * To add default method tags.
+     *
+     * @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.
+     */
+    void method2( String aString );
+
+    // one single comment
+    /**
+     * To take care of single comments.
+     *
+     * @param aString a string
+     * @return null
+     */
+    // other single comment
+    public String method3( String aString );
+
+    /**
+     * Nothing.
+     *
+     * @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.
+     */
+    public String method5( String aString );
+}

Propchange: maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithJavadoc.java
------------------------------------------------------------------------------
    svn:eol-style = native

Added: maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java?rev=792201&view=auto
==============================================================================
--- maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java (added)
+++ maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java Wed Jul  8 15:59:36 2009
@@ -0,0 +1,48 @@
+package fix.test;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * <p>InterfaceWithNoJavadoc interface.</p>
+ *
+ * @author Administrator
+ * @version $Id: $
+ * @since 1.0
+ */
+public interface InterfaceWithNoJavadoc
+{
+    /** Constant <code>MY_STRING_CONSTANT="value"</code> */
+    String MY_STRING_CONSTANT = "value";
+
+    /**
+     * <p>missingJavadoc</p>
+     *
+     * @param aString a {@link java.lang.String} object.
+     */
+    public void missingJavadoc( String aString );
+
+    // take care of identifier
+    /**
+     * <p>missingJavadoc2</p>
+     *
+     * @param aString a {@link java.lang.String} object.
+     */
+    void missingJavadoc2( String aString );
+}

Propchange: maven/plugins/trunk/maven-javadoc-plugin/src/test/resources/unit/fix-test/expected/src/main/java/fix/test/InterfaceWithNoJavadoc.java
------------------------------------------------------------------------------
    svn:eol-style = native