TestReturnTag.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23
24/*
25 * @test
26 * @bug      4490068
27 * @summary  Warn when a return tag is used on a method without a return type.
28 * @author   jamieh
29 * @library  ../lib
30 * @modules jdk.javadoc
31 * @build    JavadocTester
32 * @run main TestReturnTag
33 */
34
35public class TestReturnTag extends JavadocTester {
36
37    /**
38     * Trigger warning message when return tag is used on a void method.
39     *
40     * @return I really don't return anything.
41     */
42    public void method() {}
43
44    public static void main(String... args) throws Exception {
45        TestReturnTag tester = new TestReturnTag();
46        tester.runTests();
47    }
48
49    @Test
50    void tests() {
51        javadoc("-Xdoclint:none",
52                "-d", "out",
53                "-sourcepath", testSrc,
54                testSrc("TestReturnTag.java"));
55        checkExit(Exit.OK);
56
57        checkOutput(Output.OUT, true,
58            "warning - @return tag cannot be used in method with void return type.");
59    }
60}
61