ClassWithJavadoc.java

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.
 */
@SuppressWarnings("SameReturnValue")
public class ClassWithJavadoc
    implements InterfaceWithJavadoc
{
    /**
     * Constructor comment.
     */
    public ClassWithJavadoc()
    {
    }

    /**
     * @param aString
     */
    public ClassWithJavadoc( String aString )
    {
    }

    /**
     * public constructor with annotation
     */
    @SuppressWarnings("SameReturnValue")
    public ClassWithJavadoc( Boolean b )
    {
    }

    /**
     * private constructor with annotation
     */
    @SuppressWarnings("SameReturnValue")
    private ClassWithJavadoc( Integer i )
    {
    }

    /**
     * Spaces in tags.
     *
     * @param args      an array of strings that contains the arguments
     */
    public void spacesInJavadocTags( String[] args )
    {
    }

    /**
     * @param str
     */
    public String missingJavadocTags( String str, boolean b, int i )
    {
        return null;
    }

    /**
     * @param str
     * @throws UnsupportedOperationException if any
     */
    public String missingJavadocTags2( String str, boolean b, int i )
        throws UnsupportedOperationException
    {
        return null;
    }

    /**
     * @param str
     */
    public void wrongJavadocTag( String aString )
    {
    }

    /**
     * @param aString
     *      a string
     * @param anotherString
     *      with
     *      multi
     *      line
     *      comments
     * @return a
     *      String
     * @throws 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.
     */
    // other single comment
    public String singleComments( String aString )
    {
        return null;
    }

    /**
     * To take care of same comments.
     *
     * @param aString a string
     * @return a string
     */
    public String sameString( String aString )
    {
        return null;
    }

    /**
     * Empty Javadoc tag.
     *
     * @param
     * @return a string
     */
    public String emptyJavadocTag( String aString )
    {
        return null;
    }

    /** Comment on first line.
     *
     * @param aString a string
     * @return a string
     */
    public String javadocCommentOnFirstLine( String aString )
    {
        return null;
    }

    /**
     * Take care of last empty javadoc with unused tags.
     *
     * @param unused not
     *      used
     */
    public void unusedTag()
    {
    }

    /**
     * Take care of RuntimeException.
     *
     * @throws UnsupportedOperationException if any
     */
    public void throwsTagWithRuntimeException()
    {
    }

    /**
     * Take care of inner RuntimeException.
     *
     * @throws MyRuntimeException if any
     */
    public void throwsTagWithInnerRuntimeException()
    {
    }

    /**
     * Unknown throws RuntimeException.
     *
     * @throws UnknownRuntimeException if any
     */
    public void throwsTagWithUnknownRuntimeException()
    {
    }

    // ----------------------------------------------------------------------
    // New methods to be found by Clirr.
    // ----------------------------------------------------------------------

    /**
     * New class method to be found by Clirr.
     */
    public String newClassMethod( String aString )
    {
        return null;
    }

    // ----------------------------------------------------------------------
    // Inheritance
    // ----------------------------------------------------------------------

    /** {@inheritDoc} */
    public void method1( String aString )
    {
    }

    /**
     * {@inheritDoc}
     *
     * specific comment
     */
    public void method2( String aString )
    {
    }

    /**
     * {@inheritDoc}
     *
     * @param aString not
     *      used
     */
    public String method3( String aString )
    {
        return null;
    }

    /**
     * @param aString not
     *      used
     */
    public String method4( String aString )
    {
        return null;
    }

    /**
     * Specific comment
     *
     * @param aString not
     *      used
     */
    public String method5( String aString )
    {
        return null;
    }

    /**
     * New interface method to be found by Clirr.
     */
    public String newInterfaceMethod( String aString )
    {
        return null;
    }

    // ----------------------------------------------------------------------
    // Inner classes
    // ----------------------------------------------------------------------

    /**
     * No javadoc for inner class.
     */
    public class InnerClass
    {
        /**
         * constructor
         */
        public InnerClass()
        {
        }

        public void nothing()
        {
        }
    }

    /**
     * RuntimeException
     */
    public static class MyRuntimeException
        extends RuntimeException
    {
    }

    /**
     * private method with annotation
     */
    @SuppressWarnings("SameReturnValue")
    private void t000()
    {
        return;
    }

    /**
     * private method with line comment
     */
    //test comment
    private void t001()
    {
        return;
    }

    /**
     * public method with annotation
     */
    @SuppressWarnings("SameReturnValue")
    public void t010()
    {
        return;
    }

    /**
     * public method with annotation
     */
    //test comment
    public void t011()
    {
        return;
    }
}

/**
 * To test package class
 */
@SuppressWarnings("SameReturnValue")
class PrivateTestClassWithJavadoc
{
}