Java example source code file (DocTest.java)

This example Java source code file (DocTest.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

bytearrayoutputstream, doctest, doctestwithtags, exception, fullinheritdocdoctest, fullinheritdocplusdoctest, minimallyextendsdoctest, note, printstream, requirements, simpleextendsdoctest, simpleinheritdocdoctest, string

The DocTest.java Java example source code

/*
 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * @test
 * @bug 8008768
 * @summary Using {@inheritDoc} in simple tag defined via -tag fails
 * @author Mike Duigou
 * @run main DocTest
 */

import java.io.*;

/**
 * DocTest documentation.
 *
 * @apiNote DocTest API note.
 * @implSpec DocTest implementation spec.
 * @implNote DocTest implementation note.
 */
public class DocTest {
    public static void main(String... args) throws Exception {
        String[] javadoc_args = {
            "-verbose",
            "-d", "DocTest",
            "-tag", "apiNote:optcm:<em>API Note",
            "-tag", "implSpec:optcm:<em>Implementation Requirements:",
            "-tag", "implNote:optcm:<em>Implementation Note:",
            "-package",
            new File(System.getProperty("test.src"), "DocTest.java").getPath()
        };

        // javadoc does not report an exit code for an internal exception (!)
        // so monitor stderr for stack dumps.
        PrintStream prevErr = System.err;
        ByteArrayOutputStream err_baos = new ByteArrayOutputStream();
        PrintStream err_ps = new PrintStream(err_baos);
        System.setErr(err_ps);

        int rc;
        try {
            rc = com.sun.tools.javadoc.Main.execute(javadoc_args);
        } finally {
            err_ps.close();
            System.setErr(prevErr);
        }

        String err = err_baos.toString();
        System.err.println(err);

        if (rc != 0)
            throw new Exception("javadoc exited with rc=" + rc);

        if (err.contains("at com.sun."))
            throw new Exception("javadoc output contains stack trace");
    }

    /**
     * DocTest() documentation.
     *
     * @apiNote DocTest() API note.
     * @implSpec DocTest() implementation spec.
     * @implNote DocTest() implementation note.
     */
    public DocTest() {
    }

    /**
     * DocTest.testMethod() documentation.
     *
     * @apiNote DocTest.testMethod() API note.
     * @implSpec DocTest.testMethod() implementation spec.
     * @implNote DocTest.testMethod() implementation note.
     */
    public void testMethod() {
    }
}

/**
 * DocTestWithTags documentation.
 *
 * @apiNote DocTestWithTags API note.
 * <pre>
 *    DocTestWithTags API note code sample.
 * </pre>
 * @implSpec DocTestWithTags implementation spec.
 * <pre>
 *    DocTestWithTags implementation spec code sample.
 * </pre>
 * @implNote DocTestWithTags implementation note.
 * <pre>
 *    DocTestWithTags implementation note code sample.
 * </pre>
 */
class DocTestWithTags {

    /**
     * DocTestWithTags() documentation.
     *
     * @apiNote DocTestWithTags() API note.
     * <pre>
     *    DocTestWithTags() API note code sample.
     * </pre>
     * @implSpec DocTestWithTags() implementation spec.
     * <pre>
     *    DocTestWithTags() implementation spec code sample.
     * </pre>
     * @implNote DocTest() implementation note.
     * <pre>
     *    DocTest() implementation note code sample.
     * </pre>
     */
    public DocTestWithTags() {
    }

    /**
     * DocTest.testMethod() documentation.
     *
     * @apiNote DocTestWithTags.testMethod() API note.
     * <pre>
     *    DocTestWithTags.testMethod() API note code sample.
     * </pre>
     * @implSpec DocTestWithTags.testMethod() implementation spec.
     * <pre>
     *    DocTestWithTags.testMethod() API implementation spec code sample.
     * </pre>
     * @implNote DocTest.testMethod() implementation note.
     * <pre>
     *    DocTest.testMethod() API implementation code sample.
     * </pre>
     */
    public void testMethod() {
    }
}

class MinimallyExtendsDocTest extends DocTest {
}

/**
 * SimpleExtendsDocTest documentation.
 */
class SimpleExtendsDocTest extends DocTest {

    /**
     * SimpleExtendsDocTest() documentation.
     */
    public SimpleExtendsDocTest() {

    }

    /**
     * SimpleExtendsDocTest.testMethod() documenation.
     */
    @java.lang.Override
    public void testMethod() {
    }
}

/**
 * {@inheritDoc}
 */
class SimpleInheritDocDocTest extends DocTest {

    /**
     * {@inheritDoc}
     */
    public SimpleInheritDocDocTest() {
    }

    /**
     * {@inheritDoc}
     */
    @java.lang.Override
    public void testMethod() {
    }
}

/**
 * {@inheritDoc}
 *
 * @apiNote {@inheritDoc}
 * @implSpec {@inheritDoc}
 * @implNote {@inheritDoc}
 */
class FullInheritDocDocTest extends DocTest {

    /**
     * {@inheritDoc}
     *
     * @apiNote {@inheritDoc}
     * @implSpec {@inheritDoc}
     * @implNote {@inheritDoc}
     */
    public FullInheritDocDocTest() {

    }

    /**
     * {@inheritDoc}
     *
     * @apiNote {@inheritDoc}
     * @implSpec {@inheritDoc}
     * @implNote {@inheritDoc}
     */
    @java.lang.Override
    public void testMethod() {
    }
}

/**
 * {@inheritDoc} and FullInheritDocPlusDocTest documentation.
 *
 * @implSpec {@inheritDoc} and FullInheritDocPlusDocTest API note.
 * @implNote {@inheritDoc} and FullInheritDocPlusDocTest implementation specification.
 * @apiNote {@inheritDoc} and FullInheritDocPlusDocTest implementation note.
 */
class FullInheritDocPlusDocTest extends DocTest {

    /**
     * {@inheritDoc} and FullInheritDocPlusDocTest() documentation.
     *
     * @implSpec {@inheritDoc} and FullInheritDocPlusDocTest() API note.
     * @implNote {@inheritDoc} and FullInheritDocPlusDocTest() implementation specification.
     * @apiNote {@inheritDoc} and FullInheritDocPlusDocTest() implementation note.
     */
    public FullInheritDocPlusDocTest() {

    }

    /**
     * {@inheritDoc} and FullInheritDocPlusDocTest.testMethod() documentation.
     *
     * @implSpec {@inheritDoc} and FullInheritDocPlusDocTest.testMethod() API note.
     * @implNote {@inheritDoc} and FullInheritDocPlusDocTest.testMethod() implementation specification.
     * @apiNote {@inheritDoc} and FullInheritDocPlusDocTest.testMethod() implementation note.
     */
    @java.lang.Override
    public void testMethod() {
    }
}